creating-adrs
Structured ADR creation in MADR format. Triggers: ADR, Architecture Decision, 決定記録, 技術選定, アーキテクチャ決定, design decision, 技術的決定, 設計判断, deprecation, 非推奨化, process change, プロセス変更
When & Why to Use This Skill
The ADR Creator skill automates the generation of structured Architecture Decision Records (ADRs) following the MADR (Markdown Architectural Decision Records) format. It streamlines the documentation of critical engineering decisions, technology selections, and design patterns, ensuring consistency through automated template selection, validation, and indexing within the project repository.
Use Cases
- Technology Selection: Documenting the rationale behind choosing specific libraries, frameworks, or databases, including a detailed comparison of alternatives and trade-offs.
- Architectural Pattern Documentation: Recording significant design shifts, such as moving to a microservices architecture or implementing new design policies, to maintain a clear project history.
- Process Change Management: Formalizing updates to development workflows, coding standards, or team rules with clear 'before and after' comparisons.
- System Deprecation Planning: Managing the retirement of legacy technologies or APIs by documenting the migration plan, timeline, and impact on the existing ecosystem.
| name | creating-adrs |
|---|---|
| description | > |
| allowed-tools | [Read, Write, Edit, Grep, Glob, Bash(ls:*, mkdir:*), Task] |
| user-invocable | false |
ADR Creator
6-Phase Process
| Phase | Actions |
|---|---|
| 1. Pre-Check | ls adr/*.md, check duplicates, get next number |
| 2. Template | Match keywords to template type |
| 3. References | Gather project docs, issues, external resources |
| 4. Validate | Check required sections (Title, Status, Context, Decision, Consequences) |
| 5. Index | Auto-generate adr/README.md |
| 6. Recovery | Handle missing dirs, duplicates, missing sections |
Template Selection
| Template | Use Case | Required Sections |
|---|---|---|
| technology-selection | Library, framework choices | Options (min 3), Pros/Cons |
| architecture-pattern | Structure, design policy | Context, Consequences |
| process-change | Workflow, rule changes | Before/After comparison |
| deprecation | Retiring technology | Migration plan, Timeline |
Directory Structure
adr/
├── README.md # Auto-generated index
├── 0001-*.md # Sequential numbering
└── 0002-*.md
References
| Topic | Resource |
|---|---|
| MADR | https://adr.github.io/madr/ |
| Command | ../../commands/adr.md |
| Templates | ../../templates/adr/ |
| Scripts | ./scripts/ |