~linuxgoose/engineering-templates

ref: f97ba688267c4dfe53620b9cf9dc15a2006f36c9 engineering-templates/templates/architecture-decision-record.md -rw-r--r-- 1.5 KiB
f97ba688Jordan Robinson add architecture decision record template 3 months ago

#Architecture Decision Record (ADR)

ADR Number: [ADR-XXX]
Title: [Brief title of architectural decision]
Status: [Proposed/Accepted/Deprecated/Superseded by ADR-XXX]
Date: [Created date]
Last Updated: [Date]
Author: [Name]
Stakeholders: [List of stakeholders involved]

#Context

Describe the issue or problem that motivated this decision. What circumstances made this decision necessary? Include relevant background, constraints, and business drivers.

#Decision

State the architectural decision clearly and concisely. What exactly are we deciding to do?

#Rationale

Explain why this decision was made:

  • Why this approach over alternatives
  • How it addresses the context/problem
  • Technical and business justifications
  • Long-term implications

#Alternatives Considered

List other options evaluated:

Alternative 1: [Name]

  • Pros
  • Cons
  • Why not chosen

Alternative 2: [Name]

  • Pros
  • Cons
  • Why not chosen

#Consequences

#Positive

  • Benefits of this decision
  • What improves

#Negative

  • Trade-offs and compromises
  • Future constraints
  • Maintenance burden

#Neutral

  • No significant impact areas

#Implementation Notes

  • How will this be implemented?
  • Which teams are responsible?
  • Timeline considerations
  • Dependencies
  • References to related decisions
  • Supersedes (if applicable)
  • Is superseded by (if applicable)

#References

  • Links to relevant documentation
  • External resources
  • Design documents