template.md 1.6 KB
[short title of solved problem and solution]
- Status: [proposed | rejected | accepted | deprecated | … | superseded by ADR-1234]
- Authors: [list everyone who authored the decision]
- Date: [YYYY-MM-DD when the decision was last updated]
- Targeted modules: [which crate or module does this change target]
- Associated tickets/PRs: [PR/issue links]
Context and Problem Statement
[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.]
Decision Drivers
- [driver 1, e.g., a force, facing concern, …]
- [driver 2, e.g., a force, facing concern, …]
- …
Considered Options
[Option 1]
[example | description | pointer to more information | …]
Pros:
- Good, because [argument …]
Cons:
- Bad, because [argument …]
[Option 2]
...
[Option 3]
...
Decision Outcome
Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)].
Positive Consequences
- [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
- …
Negative Consequences
- [e.g., compromising quality attribute, follow-up decisions required, …]
- …
Links
- [Link type] [Link to ADR]
- …