What problem does it solve?
This Skill provides conventions and guidance for managing Architecture Decision Records (ADRs) in software projects, ensuring clarity and consistency in architectural decision-making.
Core Features & Use Cases
- ADRs as Constraints: Defines best practices for using ADRs as binding constraints in project development.
- ADR Format: Standardizes the format of ADRs to maintain consistency across the project.
- Creating New ADRs: Offers guidance on when and how to create new ADRs, including content structure and length guidelines.
- Superseding and Deprecating: Explains the process for superseding or deprecating existing ADRs when necessary.
- Planning: Assists in planning architectural changes by requiring ADR creation as a step in the implementation plan.
- Use Case: When starting a new project or making significant architectural changes to an existing one, use this Skill to document decisions and maintain a clear record of the project's evolution.
Quick Start
To create a new ADR, run the command: adr create "My New ADR Title" --context "Description of the problem and context" --decision "The decision made" --consequences "The expected outcomes" --status "Proposed"