Short title of solved problem and solution [Describe the general problem and the chosen solution in free from in a few sentences. Leave specific details for the following sections]
-
Status: [proposed | in progress | rejected | accepted | deprecated by | obsoletes | continued by | | extended by ADR-0005-Example - Date
-
[e.g.: _Status: accepted 2019-05-04 proposed 2019-04-12 deprecated by (ADR-006-example-title)[ADR-link]]
-
Author(s): [document owner and/or main writer]
-
Deciders: [list everyone involved in the decision, it is acceptable to refer a whole team]
- Related issues:
- PROJECT-XXX Epic
- PROJECT-XX1
- Related documments:
- [f.i. Wiki documents, architecture diagrams, external links, a pdf, if needed use Bibliographical quote style like http://www.citethisforme.com/citation-generator/harvard]
[Describe the full context of the problem in free form, use ## sections to better organize the description.]
- [driver 1, e.g., a force, facing concern, …]
- [driver 2, e.g., a force, facing concern, …]
- …
[ e.g. Typical decision drivers: scalability, timing, resources, simplicity, security, coherence with other projects, knowledge on a certain tech, reusability, maintainability budget, ...]
- [option 1]
- [option 2]
- [option 3]
- …
Chosen option: "[option 1]", because [justification. e.g., only option | mets mot criterion decision driver | which resolves it this way | … | comes out best (see below)].
<> (Can be a list or a group of sections or a combination. Always list them.)
- [pro 1]
- [prov 2]
- [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]
<! Negative consequences and potential risks --> <! Can be a list or a group of sections or a combination. Always list them.>
- [e.g., compromising quality attribute, follow-up decisions required, …]
- …
Topics for next iterations or ideas to tackle the identified Cons and Risks
- [Link type] Link to ADR
- …