Skip to content

ADR Short Template

Copy this file to NNNN-title-with-dashes.md and fill in the sections below. Add the following YAML frontmatter:

---
status: proposed
contact: (person proposing the ADR)
date: YYYY-MM-DD
deciders: (list everyone involved in the decision)
---

{short title of solved problem and solution}

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

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 option 1}", because {justification}.

Consequences

  • Good, because {positive consequence}
  • Bad, because {negative consequence}