Documentation Style Guide (Draft)¶
Principles:
- Audience first: specify audience at top when not obvious.
- Prefer short declarative sentences.
- Use present tense for system behavior.
- Provide rationale when recommending a pattern.
- One concept per heading section.
Formatting:
- Headings: sentence case (capitalize first word only unless proper noun)
- Tables: include header row and align pipes
- Admonitions: Use
Note,Warning,Tipappropriately
Required Sections (when applicable): Context, Decision, Consequences (for ADRs); Overview, Steps, References (for runbooks).