Generate ADR Skill
Create Architecture Decision Records for technical decisions.
When to Use
- •Making significant architectural decisions
- •Choosing between technical alternatives
- •Documenting design trade-offs
- •Recording rationale for future reference
Quick Reference
bash
./scripts/create_adr.sh "Decision Title" # Creates: docs/adr/ADR-XXX-decision-title.md
Workflow
- •Identify decision - What choice needs documentation?
- •Research alternatives - Gather evidence and performance data
- •Create ADR - Run script with title
- •Fill sections - Context, Decision, Rationale, Consequences, Alternatives
- •Review - Get team approval
- •Update status - Change from "Proposed" to "Accepted"
ADR Format
All ADRs follow this structure:
markdown
# ADR-XXX: Title **Status**: Proposed | Accepted | Deprecated | Superseded **Date**: YYYY-MM-DD **Deciders**: Names/roles ## Context What is the issue we're facing? ## Decision What decision are we making? ## Rationale Why this decision? Key reasons. ## Consequences ### Positive - Benefit 1 ### Negative - Drawback 1 ### Neutral - Other impact 1 ## Alternatives Considered ### Alternative 1 Why not chosen.
Status Lifecycle
- •Proposed - Under consideration
- •Accepted - Decision made and active
- •Deprecated - No longer recommended
- •Superseded - Replaced by newer ADR
Storage Location
text
docs/adr/ ├── ADR-001-language-selection.md ├── ADR-002-testing-strategy.md └── README.md
Error Handling
| Issue | Fix |
|---|---|
| Missing context | Add background and constraints |
| Unclear decision | Make decision more specific |
| Missing alternatives | Document at least 2 alternatives |
| No consequences | Think through positive and negative impacts |
References
- •See existing ADRs in
/docs/adr/for examples - •Related skill:
phase-plan-generatefor planning