ADR
Architecture Decision Record
Context, decision, consequences. The alternatives section is the valuable one.
- Format.md
- Length41 lines
- Includesnone
The source
41 lines of Markdown, with nothing to install. Copy it, or open the template inside Gnomon and render it as it is.
# ADR-NNN: <Decision title>
- **Status:** Proposed | Accepted | Deprecated | Superseded by [ADR-XXX](./adr-xxx.md)
- **Date:** YYYY-MM-DD
- **Deciders:** <names / roles>
## Context
What is the issue we're seeing that motivates this decision? What forces are at play
(technical, organisational, regulatory)? Keep it short — link out to deeper docs.
## Decision
We will <do X>.
State the decision in active voice. One paragraph, not a wall.
## Consequences
### Positive
- …
- …
### Negative
- …
- …
### Neutral
- …
## Alternatives Considered
### Option A — <name>
Brief description. Why rejected.
### Option B — <name>
Brief description. Why rejected.
## Notes
Links to discussions, PRs, prior art.Render this offline
This template ships in Gnomon and renders on your machine, with no account and nothing sent to a server. The browser editor is free and needs no install.
Others in Architecture document templates
- RFC — Request for CommentsFor proposing a change and inviting disagreement before building.
- HLD — High-Level DesignHigh-level design: the shape, the constraints, the risks.
- Tech Spec / LLDLow-level design. What an implementer needs that the HLD does not say.
- NFR CatalogueThe requirements that get discovered late and expensively.
- RunbookWhat to do at 3am. Written for someone tired and unfamiliar.
- Discovery / Spike ReportFindings from a time-boxed investigation, including the dead ends.
- Post-Mortem / Incident ReviewBlameless incident review. Timeline first, conclusions second.
- Solution One-PagerA solution summary for people who will not read the HLD.