Writing Guide¶
Style¶
Write docs as durable internal references rather than chat transcripts.
Prefer:
- clear ownership statements
- explicit system boundaries
- stable terminology
- decision records for architecture changes
Suggested conventions¶
- one workflow per page
- one system per page
- one ADR per decision
- tables for ownership and status mappings
Good page pattern¶
- Purpose
- Scope
- Ownership
- Inputs and outputs
- Statuses or events
- Exceptions or escalation paths