Appearance
Architectural Decision Records (ADR) & Documentation Standard
💡 Copyable AI Prompt Block (
AGENTS.md)
markdown
<!-- START AGENT-STANDARD: GENERAL-DOCUMENTATION-ADR -->
## Documentation & ADR Rules
- Document architectural decisions in `docs/adr/000X-*.md` using the Nygard template format.
- Update `CONTEXT.md` immediately whenever domain terminology or architecture boundaries evolve.
- Maintain dual-format standards: copyable AI blocks at top, detailed human guides below.
<!-- END AGENT-STANDARD: GENERAL-DOCUMENTATION-ADR -->Detailed Human Guide & Rationale
(Detailed guide to be authored collaboratively)
1. Nygard ADR Template & Architecture Lifecycle
(Formatting decisions with Context, Decision, Status, and Consequences in docs/adr/)
2. CONTEXT.md Maintenance & Domain Glossary Sync
(Updating single-source context files when architectural decisions or terms are finalized)
3. Dual-Format Standard Authoring & Primary Source Evidence
(Authoring standards with copyable AI blocks, human Guides, and verified evidence links)
Primary Evidence & References
- Michael Nygard Architectural Decision Records (ADR): https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
- Martin Fowler Architecture Knowledge Capture: https://martinfowler.com/architecture/