Madhura68
8a7d419972
Set up docs/adr/ as the canonical home for architecture decisions: - templates/nygard.md — default four-section format (Status, Context, Decision, Consequences) for one-way-door decisions. - templates/madr.md — MADR v4 with YAML front-matter and explicit Considered Options for decisions where rejected alternatives matter. - README.md — naming convention (NNNN-kebab-case), template-selection guidance (Nygard default; MADR for auth, queue mechanics, agent integration), status lifecycle, and ADR roster. - 0000-record-architecture-decisions.md — meta-ADR establishing the practice itself, in Nygard format. Backfilling existing implicit decisions (base-ui-over-radix, float sort_order, demo-user three-layer policy, etc.) is fase 6 of the docs-restructure plan.
31 lines
975 B
Markdown
31 lines
975 B
Markdown
# ADR-{{NNNN}}: {{Short noun phrase describing the decision}}
|
|
|
|
## Status
|
|
|
|
{{proposed | accepted | superseded by ADR-NNNN | deprecated}}
|
|
|
|
## Context
|
|
|
|
{{What is the issue we're seeing that motivates this decision? Describe the
|
|
forces at play — technical, organizational, business — that make this choice
|
|
necessary now. State facts, not opinions. Keep it short: one or two
|
|
paragraphs is usually enough. If a reader needs background that lives
|
|
elsewhere, link to it instead of duplicating.}}
|
|
|
|
## Decision
|
|
|
|
{{The choice we've made, written in present tense as a declarative statement.
|
|
"We will use X." "We adopt Y." Avoid hedging language. One paragraph.}}
|
|
|
|
## Consequences
|
|
|
|
### Positive
|
|
|
|
- {{What becomes easier or possible because of this decision?}}
|
|
- {{What problem is no longer relevant?}}
|
|
|
|
### Negative
|
|
|
|
- {{What becomes harder, slower, or more expensive?}}
|
|
- {{What did we accept as a trade-off?}}
|
|
- {{What new risks does this introduce, and how do we mitigate them?}}
|