{short title, representative of solved problem and found solution}
| Field | Value |
|---|---|
| status | {proposed | rejected | accepted | deprecated | … | superseded by ADR-0123 |
| date | {YYYY-MM-DD when the decision was last updated} |
| decision-makers | {list everyone involved in the decision} |
| consulted | {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication} |
| informed | {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication} |
Context and Problem Statement
Section titled “Context and Problem Statement”{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.}
Decision Drivers
Section titled “Decision Drivers”- {decision driver 1, e.g., a force, facing concern, …}
- {decision driver 2, e.g., a force, facing concern, …}
- …
Considered Options
Section titled “Considered Options”- {title of option 1}
- {title of option 2}
- {title of option 3}
- …
Decision Outcome
Section titled “Decision Outcome”Chosen option: “{title of option 1}”, because {justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force {force} | … | comes out best (see below)}.
Consequences
Section titled “Consequences”- Good, because {positive consequence, e.g., improvement of one or more desired qualities, …}
- Bad, because {negative consequence, e.g., compromising one or more desired qualities, …}
- …
Confirmation
Section titled “Confirmation”{Describe how the implementation of/compliance with the ADR can/will be confirmed. Are the design that was decided for and its implementation in line with the decision made? E.g., a design/code review or a test with a library such as ArchUnit can help validate this. Not that although we classify this element as optional, it is included in many ADRs.}
Pros and Cons of the Options
Section titled “Pros and Cons of the Options”{title of option 1}
Section titled “{title of option 1}”{example | description | pointer to more information | …}
- Good, because {argument a}
- Good, because {argument b}
- Neutral, because {argument c}
- Bad, because {argument d}
- …
{title of other option}
Section titled “{title of other option}”{example | description | pointer to more information | …}
- Good, because {argument a}
- Good, because {argument b}
- Neutral, because {argument c}
- Bad, because {argument d}
- …
More Information
Section titled “More Information”{You might want to provide additional evidence/confidence for the decision outcome here and/or document the team agreement on the decision and/or define when/how this decision the decision should be realized and if/when it should be re-visited. Links to other decisions and resources might appear here as well.}