Documentation Style Guide¶
Principles¶
- Externalize knowledge (explain the "why").
- Reduce cognitive load (tables, diagrams, code blocks).
- Enable fast re-entry (clear titles, numbered steps).
Conventions¶
- Use English for canonical docs (see
docs/documentation_rules.md). - Minimum structure:
- Context
- Objective
- Steps or technical details
- Expected results
- Provide self-contained examples that can be copied.
- Document endpoints with:
- Method
- Path
- Parameters
- JSON example