39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
## Documentation Methodology
|
|
|
|
The project planning happens on the _Jira board_ and the project documentation is added to _Confluence pages_.
|
|
The setting up of Jira & Confluence is outlined in [Project Lifecycle](project_planning.md#project-lifecycle).
|
|
|
|
### General Tips
|
|
* Include conceptual graphical documentation as inline embedded images.
|
|
* Save Matplotlib / Seaborn plots as `.svg`.
|
|
* Sketches and handwritten illustrations scanned / photographed as `.png`/`.jpg`.
|
|
* Scanned / photographed illustrations should be cropped, contrast and alligned.
|
|
* Technical Writing resources
|
|
* [Pivic technical writing](https://pivic.blog/blog/technical-writing/)
|
|
* [HNews comment](https://news.ycombinator.com/item?id=32344610)
|
|
|
|
### Markdown Tips
|
|
|
|
* Use [Google's Markdown Style Guide](https://google.github.io/styleguide/docguide/style.html) for written documentation.
|
|
|
|
<details>
|
|
|
|
<summary>
|
|
Click here to see the markdown _code_ for foldable cell 🎆
|
|
|
|
</summary>
|
|
|
|
|
|
```
|
|
<details>
|
|
|
|
<summary>
|
|
Click here to see the markdown _code_ for foldable cell 🎆
|
|
|
|
</summary>
|
|
|
|
(code cell content)
|
|
|
|
</details>
|
|
```
|
|
</details>
|