Skip to content

adr-template.md

Latest commit

 

History

History
82 lines (53 loc) · 3.16 KB

adr-template.md

File metadata and controls

82 lines (53 loc) · 3.16 KB

[Short title of solved problem and solution]

  • Status: [proposed | rejected | accepted | deprecated | superseded by xxxx]
  • Date: [YYYY-MM-DD when the decision was last updated]
  • Work Item: [Identifier and name of the work item initiating the decision linked to the work item and in the form of {xxxx-yyyy} where xxxx is the number of the work item and yyyy is the name of the work item.]

Context and Problem

[Describe the context and problem in which the decision is being made in free form using a couple of sentences or in form of an illustrative story.]

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

Decision Outcome

Chosen option: "[title of chosen option]," because [justification, e.g., the only option, which meets 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, ...]

Implementation

[Describe the steps required to implement the decision, including any dependencies, timelines, or resource allocations.]

Confirmation

[Describe how the implementation of/compliance with the ADR is confirmed.]

Stakeholders

[List the stakeholders involved in or affected by the decision. This may include individuals, teams, departments, or external parties.]

Pros and Cons of the Options

[Title of Option 1]

  • Good, because [argument a]
  • Good, because [argument b]
  • Neutral, because [argument c]
  • Bad, because [argument d]
  • ... {numbers of pros and cons car vary}

[Title of Other Option]

  • Good, because [argument a]
  • Good, because [argument b]
  • Neutral, because [argument c]
  • Bad, because [argument d]
  • ...

More Information

[You might want to provide additional evidence/confidence for the decision outcome here and/or document the team agreement or the decision and/or define when/how this decision should be realized and if/when it should be re-visited. Links to other decisions and resources might appear here as well. If there is no more information, please use "No more information available".]

Follow-On Information

[Provide details about what happens to the ADR after approval or rejection (and the record is immutable). This section can include information about any updates, revisions, or further actions taken based on the decision outcome.]

Record History

  • Proposed: [Date]
  • Rejected: [Date, if applicable]
  • Accepted: [Date, if applicable]
  • Last Reviewed: [Date, if appliable]
  • Deprecated: [Date, if applicable]
  • Superseded by: [Reference to the ADR that supersedes this one, if applicable]
  • Date Superseded: [Date, if applicable]
  • Archived: [Date, if applicable]