3 ms·
I write the kind of documentation that would help me to get to know a codebase quickly. - Architecture: what modules are there, what are their responsibilities
by vnorilo 6y ago
I write the kind of documentation that would help me to get to know a codebase quickly.
- Architecture: what modules are there, what are their responsibilities? What is in scope and out of scope (non-goals are super important). Keep this short and sweet.
- Tutorials: Show how to do some common tasks with the code. A good way to communicate intended life cycles and best practices.
- Reference: Details. I feel API contracts are the most important. I prefer trying to eliminate this type as much as possible, by trying to make invalid usage unrepresentable. If your team uses IDEs, consider putting this in a format that shows up in autocomplete/inline docs. How much you need this depends a lot on if you're working with dynamic or static types.