Create Architecture Decision Record
Create new ADRs under docs/ADR/. Content is English. File names use
English kebab-case. The numbering prefix is project-specific
(e.g. DT for duckTerm, TEZG for tezgah) — ask the user once per repo,
then reuse it.
Format
ADRs follow the MADR-lite format:
# <PREFIX>-NNNN: Title
* **Date:** YYYY-MM-DD
* **Status:** Proposed | Accepted | Deprecated | Superseded by <PREFIX>-NNNN
* **Domain:** Architecture & Governance
## Context
[Problem statement and background]
## Decision
[The decision with numbered sub-sections]
## Consequences
* **Positive:** [benefits]
* **Negative:** [trade-offs]
## References
* [cross-references to other ADRs]
Procedure
- Read
docs/ADR/INDEX.mdto find the next available number. - Create
docs/ADR/<PREFIX>-NNNN-short-descriptive-title.mdwith the format above. - Fill all sections with English content.
- Set the
Statusfield:Proposed,Accepted,Deprecated, orSuperseded. - Update
docs/ADR/INDEX.md— add a row to the ledger table. - Commit with
docs(adr): add <PREFIX>-NNNN title.
Rules
- Never delete historical ADRs. Mark old ones as
DeprecatedorSuperseded. - Sequential numbering, no gaps.
- English prose only in ADR bodies.
- Keep
docs/ADR/INDEX.mdup to date. - Stage only the ADR files. Never bundle unrelated changes.