documentation.md

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.

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
  • HNews comment

Writing resource

• write and think more clearly
• technical writing for engineers
• on technical writing

Markdown Tips

• Use Google's Markdown Style Guide for written documentation.

Click here to see the markdown _code_ for foldable cell 🎆

<details>

<summary>
Click here to see the markdown _code_ for foldable cell 🎆

</summary>

  (code cell content)

</details>