ADR template
This commit is contained in:
38
reference/decisions/template.md
Normal file
38
reference/decisions/template.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# ADR-NNNN: Decision Title
|
||||||
|
|
||||||
|
* **Status:** Proposed
|
||||||
|
* **Date:** YYYY-MM-DD
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Describe the problem or architectural question that requires a decision.
|
||||||
|
|
||||||
|
Explain the relevant requirements, constraints, risks, and assumptions. Keep this section focused on why the decision is needed.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Describe the selected approach clearly and directly.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
### Alternative 1
|
||||||
|
|
||||||
|
Briefly describe the alternative and why it was not selected.
|
||||||
|
|
||||||
|
### Alternative 2
|
||||||
|
|
||||||
|
Briefly describe the alternative and why it was not selected.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
### Positive
|
||||||
|
|
||||||
|
* List the main benefits of the decision.
|
||||||
|
|
||||||
|
### Negative
|
||||||
|
|
||||||
|
* List the costs, limitations, and trade-offs introduced by the decision.
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
Add implementation details, unresolved questions, or links to related documents when necessary.
|
||||||
Reference in New Issue
Block a user