Architecture Decision Records¶
An ADR records a decision that reaches beyond a single capability and is hard to reverse. A decision that concerns one capability belongs in that Capability Specification's Decisions section instead.
Name each ADR ADR-NNN-short-title.md, numbered in order. An ADR is frozen once a release tag
contains it; a later decision supersedes it with a new ADR instead of changing it.
This file is written by repo update; keep notes in another file.
Template¶
# ADR-NNN: Title
**Status**: Proposed | Accepted | Superseded by ADR-NNN
**Date**: YYYY-MM-DD
## Context
The forces at play and the requirement that makes a decision necessary.
## Decision
The decision, in one or two sentences.
## Alternatives
Each considered alternative with the reason it was not chosen.
## Consequences
What becomes easier and what becomes harder.