Skip to main content

ADR-0000: Architecture Decision Record Template

Status

[Proposed | Accepted | Deprecated | Superseded]

Context

Describe the issue motivating this decision or change. What is the architectural constraint that we're working with?

Decision

State the architectural direction that we have chosen.

Consequences

Describe the resulting context, after applying the decision. All consequences should be listed here, not just the "positive" ones. A particular decision may have positive, negative, and neutral consequences, but all of them affect the team and project in the future.

Alternatives Considered

List the alternatives that were considered, and why they were not chosen.

Implementation Notes

Any specific implementation details, code examples, or configuration changes needed.

References

  • Link to related issues, PRs, or external documentation
  • Link to other ADRs that this decision relates to

Template Usage:

  1. Copy this template for new ADRs
  2. Use sequential numbering (ADR-0001, ADR-0002, etc.)
  3. Update the status as the decision progresses
  4. Link related ADRs in the references section