Skip to content

Files

Latest commit

7b5ffb0 · Aug 30, 2023

History

History
112 lines (76 loc) · 4.46 KB

adr-template.md

File metadata and controls

112 lines (76 loc) · 4.46 KB

{short title of solved problem and solution}


  • status: {draft | submitted to TDA | accepted | rejected}
  • supersedes: { - | ADR-0004}
  • superseded by: { - | ADR-0005}
  • date: {YYYY-MM-DD when the decision was last updated}
  • author: {contact or informed captain for this ADR}
  • approval level: {low | medium | high}
  • coordinated with: {list everyone involved in the decision and whose opinions were sought (e.g. subject-matter experts)}
  • source: {(link to) ticket / epic / issue that lead to the creation of this ADR}
  • scope: { - | ADR is only valid {until date | until event | as a workaround until better solution … exists} | in project … | in product … (defaults to the directory this ADR is stored in)}
  • resubmission: { - | YYYY-MM-DD if the scope is time-limited}

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

  • {decision driver 1, e.g., a force, facing concern, …}
  • {decision driver 2, e.g., a force, facing concern, …}

Considered Options

  • {title of option 1}
  • {title of option 2}
  • {title of option 3}

Pros and Cons of the Options

{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}

{example | description | pointer to more information | …}

  • Good, because {argument a}
  • Good, because {argument b}
  • Neutral, because {argument c}
  • Bad, because {argument d}

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

  • 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, …}

Risks

  • When implementing the decision, a {small, medium, high} risk exists, that {…}.

Confirmation

{Describe how the implementation of/compliance with the ADR is confirmed. E.g., by a review or an ArchUnit test. Although we classify this element as optional, it is included in most ADRs.}

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 this decision and how the decision should be realized and if/when it should be re-visited and/or how the decision is validated. Links to other decisions and resources might appear here as well.}