673 B
673 B
Documentation Rules
Principles
- Single source of truth per topic; link, do not duplicate.
- Update docs in same change set as code.
- Prefer observable behavior (what to run, what to see).
Canonical Locations
- Architecture/system boundaries:
docs/architecture.md - Execution plans:
docs/execplans/+ policy indocs/PLANS.md - Operational procedures:
docs/runbooks/ - Cross-cutting decisions:
docs/adr/ - Known gaps:
docs/risks.md
Minimum Review Checklist
- Docs touched or explicitly unchanged.
- Runbook updated for production-impacting flow changes.
- ADR added when decision is hard to reverse.
- Risks updated when a major gap opens/closes.