An Architectural Decision Record (ADR) is a short document that explains:
- What architectural decision was made
- Why it was made
- What alternatives were considered
- What implications it has
📄 What does a typical ADR include?
A common format may contain the following sections:
Title - A descriptive name for the decision
Status - For example: Proposed, Accepted, Rejected
Context - The problem or situation that led to the decision
Decision - What was decided and how it will be implemented
Consequences - Positive or negative effects of the decision
Alternatives - Other options that were considered and why they were discarded
Date - When the decision was made
📦 What are they for?
- They document the reasoning behind a technical choice
- Help maintain design consistency over time
- Are useful for onboarding new team members
- Serve as a reference for future reviews
Example: