Home / Learn / Keep your users happy: how to document code the right way

---

Keep your users happy: how to document code the right way

---

Lecture 1: Documenting code; why bother and how to do it right

Code documentation is just as important as the code itself. Learn in this article what the three main types of documentation are and how to write them properly.

Read article

---

Lecture 2: How to write a 1-page readme file to document your code

Learn in this article how to structure 1-page software documentation and how to write them using Markdown, including examples for how to document CFD libraries

Read article

---

Lecture 3: How to write a user guide to document your CFD code

Learn how to write a user guide from scratch using reStructuredText and Sphinx. We see how to do that quickly and effectively so your users stay happy

Read article

---

Lecture 4: How to annotate C++ code for automatic code documentation

Learn how to write effective code documentation using Doxygen and how to avoid documentation that no one reads and no one wants to write.

Read article