zebra/docs/decisions/template.md

1.5 KiB

# status and date are the only required elements. Feel free to remove the rest. status: {[proposed | rejected | accepted | deprecated | … | superseded by ADR-NAME]} date: {YYYY-MM-DD when the decision was last updated} builds-on: {Short Title} story: {description or link to contextual issue}

{short title of solved problem and solution}

Context and Problem Statement

{2-3 sentences explaining the problem and the forces influencing the decision.}

Priorities & Constraints

  • {List of concerns or constraints}
  • {Factors influencing the decision}

Considered Options

  • Option 1: Thing
  • Option 2: Another

Pros and Cons of the Options

Option 1: {Brief description}

  • Good, because {reason}
  • Bad, because {reason}

Decision Outcome

Chosen option [Option 1: Thing]

{Clearly state the chosen option and provide justification. Reference the "Pros and Cons of the Options" section below if applicable.}

Expected Consequences

  • List of outcomes resulting from this decision

More Information