Skip to content

Instantly share code, notes, and snippets.

@hectorcanto

hectorcanto/adr-template.md

Last active August 1, 2022 07:36
Show Gist options
  • Star 5 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save hectorcanto/1276e41fc24e8c4ee1427cd5d02bf82a to your computer and use it in GitHub Desktop.
Save hectorcanto/1276e41fc24e8c4ee1427cd5d02bf82a to your computer and use it in GitHub Desktop.
Download ZIP
A template for Arquitecture Decision Records
Raw
adr-template.md

ADR Template

Short Title

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]

Context and Problem Statement

[Describe the full context of the problem in free form, use ## sections to better organize the description.]

Decision

Decision Drivers

  • [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, ...]

Considered Options

  • [option 1]
  • [option 2]
  • [option 3]
  • …

Decision Outcome

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)].

Pros and expected benefits

<> (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, …]

[pro 1]

Cons and potential risks

<! 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, …]
  • …

Possible improvements

Topics for next iterations or ideas to tackle the identified Cons and Risks

Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment