Documentation Standards
Status: Canonical
Applies to: All ZAIXOS engineering documentation
Contents
| Document | Purpose |
|---|---|
| documentation-quality.md | Quality bar & review checklist |
| terminology.md | Canonical terms (platform, product, module, agent) |
| cross-linking.md | Required links on every page |
| diagrams.md | Mermaid standards |
| templates/ | Reusable page templates |
Templates
| Template | Use for |
|---|---|
| platform-template.md | PL-xxx platform pages |
| product-template.md | PRD-xxx product pages |
| module-template.md | Bounded context modules |
| agent-template.md | Agent catalog entries |
| capability-template.md | Capability catalog entries |
| adr-template.md | Architecture Decision Records |
| tutorial-template.md | How-to tutorials |
| api-template.md | Contract reference pages |
Writing rules
- Cite, don't duplicate — link to authority; never copy constitution text.
- Present tense, active voice — "The platform owns execution."
- One concept per page — split when a page exceeds ~400 lines.
- Every page has metadata — Status, Owner, Last updated, Related.
- Diagrams over prose — use Mermaid for flows with 4+ steps.
- No chat memory — if it isn't in docs, it doesn't exist.