Skip to content

Instantly share code, notes, and snippets.

@mxstbr
Last active April 3, 2023 20:55
Show Gist options
  • Save mxstbr/6a498cff553ab14e4bf715a7e9cbfcaf to your computer and use it in GitHub Desktop.
Save mxstbr/6a498cff553ab14e4bf715a7e9cbfcaf to your computer and use it in GitHub Desktop.
This is the ADR template that @mxstbr used successfully before. It is a shortened version of https://github.com/joelparkerhenderson/architecture-decision-record/blob/main/templates/decision-record-template-madr/index.md with slight renamings to make things clearer.

[short title of problem]

  • Status: [proposed | rejected | accepted | deprecated | … | superseded by ADR-0005]
  • Deciders: [list everyone involved in the decision]
  • Links: [list all the related 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.]

Evaluation Criteria

  • [criteria 1, e.g., a force, facing concern, …]
  • [criteria 2, e.g., a force, facing concern, …]

Considered Options

[option 1]

[example | description | pointer to more information | …]

  • Pros & Cons:
    • Good, because [argument a]
    • Good, because [argument b]
    • Bad, because [argument c]

Does/doesn't meet criteria and why: yes/no

[option 2]

[example | description | pointer to more information | …]

  • Pros & Cons:
    • Good, because [argument a]
    • Good, because [argument b]
    • Bad, because [argument c]

Does/doesn't meet criteria and why: yes/no

[option n]

[example | description | pointer to more information | …]

  • Pros & Cons:
    • Good, because [argument a]
    • Good, because [argument b]
    • Bad, because [argument c]

Does/doesn't meet criteria and why: yes/no

Decision Recommendation

Recommend option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion evaluation criteria | which resolves force force | … | comes out best (see below)].

Expected Positive Consequences

  • [e.g., improvement of quality attribute satisfaction, follow-up decisions required, …]

Expected Negative Consequences

  • [e.g., compromising quality attribute, follow-up decisions required, …]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment