Architecture Decision Records
Documented architectural decisions
Architecture Decision Records (ADRs)
ADRs document significant architectural decisions made during the development of ProficientNowTech systems.
What is an ADR?
An Architecture Decision Record captures:
- Context - The situation that prompted the decision
- Decision - What was decided
- Rationale - Why this decision was made
- Consequences - What results from the decision
Key Principles
- ADRs are immutable - Once accepted, they cannot be changed
- Supersession over modification - Create a new ADR to change a decision
- Context preservation - Future readers need to understand the situation
ADR Index
| ADR ID | Title | Status | Date |
|---|---|---|---|
| Coming soon |
ADRs will be migrated and created as significant architectural decisions are documented.
Creating an ADR
ADRs should be created when:
- Choosing between multiple viable alternatives
- Making a decision that will be difficult to reverse
- Setting a precedent for future decisions
- Documenting why NOT to do something
Use the ADR Template from the governance repository.
Relationship to RFCs
- RFCs propose and discuss changes (may be rejected)
- ADRs record accepted decisions (immutable once accepted)
An RFC often results in one or more ADRs documenting the specific decisions made.