adr-writer
ADR Writer guides you through building comprehensive Architecture Decision Records that capture the reasoning behind key technical choices. It provides a structured template covering context, decision rationale, alternatives evaluated, tradeoffs made, and consequences—helping teams document and communicate architecture decisions clearly.
ADR Writer helps you create structured Architecture Decision Records that document technical choices with context, alternatives, and consequences.
AI-generated summary based on this skill's SKILL.md
Install
patricio0312rev/skills/adr-writer
git clone https://github.com/patricio0312rev/skills
cp -r skills/architecture/adr-writer ~/.claude/skills/adr-writernpx skillfed install patricio0312rev/skills/adr-writerFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How to write architecture decision records with ADR Writer?
ADR Writer guides you through building comprehensive Architecture Decision Records that capture the reasoning behind key technical choices. The tool provides a structured template covering context, decision rationale, alternatives evaluated, tradeoffs made, and consequences—helping teams document and communicate architecture decisions clearly.
What does an ADR Writer template include?
ADR Writer's template covers all essential sections: context (the issue requiring a decision), decision (what was chosen), alternatives (other options considered), tradeoffs (benefits and drawbacks), and consequences (impacts of the choice). This comprehensive structure ensures technical decisions are fully documented for team review and future reference.
How can ADR Writer help document architecture decisions with alternatives?
ADR Writer structures your documentation to explicitly list and evaluate alternative approaches alongside your chosen solution. By capturing what was considered and why alternatives were rejected, ADR Writer creates a complete decision record that shows the full reasoning process and helps teams understand the context behind technical choices.
Can ADR Writer establish a decision log for engineering teams?
Yes. ADR Writer helps build a decision log to maintain accountability and visibility of technical decisions across your team. By generating consistent, structured Architecture Decision Records, the tool enables teams to track consequences and risks of architectural choices over time and maintain a searchable history of decisions.
What are architecture decision record best practices with ADR Writer?
ADR Writer implements best practices by providing a standardized format that captures decision context, rationale, and tradeoffs in one place. This approach ensures decisions are documented while fresh, communicated clearly to stakeholders, and preserved for future team members who need to understand why specific technologies or design patterns were selected.
SKILL.md
rendered from the published skill — quoted content, verbatim
ADR Writer
Document architecture decisions with clear context, alternatives, and consequences.
ADR Template
```markdown
ADR-001: [Title of Decision]
Status: Proposed | Accepted | Deprecated | Superseded by ADR-XXX Date: 2024-01-15 Deciders: Alice (Tech Lead), Bob (Principal Engineer) Owner: Alice
Context
What is the issue we're facing? What factors are driving this decision?
We need to choose a database for our new analytics service. Current requirements:
- 10M+ events per day
- Complex aggregation queries
- Real-time dashboards
- Budget: $5k/month
- Team familiar with SQL
Decision
We will use PostgreSQL with TimescaleDB extension.
Alternatives Considered
Option 1: PostgreSQL + TimescaleDB (CHOSEN)
Pros:
- Team already knows PostgreSQL
- Time-series optimization for analytics
- Reliable and proven
- Good query performance
- Reasonable
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 1 file
architecture/adr-writer/SKILL.md