- the overall idea for documentation is to capture information that
was in the mind of the designer but couldn’t be represented in the
code
- add order of operations (function calls/rest api calls) to
documentation
- inspiration: a network protocol defines the format and the order of
messages exchanged between two or more communicating entities, as well
as the actions taken on the transmission and/or receipt of a message or
other event.
- write present tense with full sentence
- write code comments, documentations before implementation
- four types of documentation
- Tutorial e.g. get started with working code
- How-To e.g. Step by Step Guides like Recipes
- Explanation e.g. experts deep dive
- Reference e.g. function docstring or python official
documentations