Documentation
README
Architecture Decisions
Purpose
Record why a decision was made, not just what was decided. Code shows the what. The context, the alternatives, and the constraints that made the choice correct at the time are otherwise lost within months.
When to Use
- Choosing a database, framework, protocol, or vendor.
- Adopting or abandoning an architectural pattern.
- Making a decision that will be expensive to reverse.
- Revisiting a decision someone made and nobody can explain.
Capabilities
- ADR authoring in a consistent, greppable format.
- Options analysis with honest trade-offs.
- Superseding and amending existing decisions without rewriting history.
Inputs
This is the opening of the README. Read the full README on GitHub.