record-adr
Use this to create or modify architecture decision records (ADRs)
Security Assessment
About record-adr
The 'record-adr' skill is designed to help users create or modify Architecture Decision Records (ADRs). ADRs are a way to document the decisions made during the design and architecture phases of software development. The skill streamlines the process of recording ADRs by providing a clear set of guidelines for writing, organizing, and storing them. This is particularly useful for teams that need to keep track of architectural decisions in a structured and consistent manner, ensuring that future team members can easily understand the reasoning behind key decisions.
FAQ
How do I record an architecture decision using this skill?
You can record an architecture decision by following the template stored in './templates/adr.md'. Ensure you describe the decision made, provide context, list the alternatives, explain the consequences, and give a unique identifier for the ADR file.
What format should the ADR file follow?
The ADR file should be named following the format '001-title-of-the-adr.md', with each ADR stored in the 'docs/architecture/adr' directory. You should also include it in the TOC of '09-decisions.md' within the 'docs/architecture' folder.
What information should I include in the context section of the ADR?
In the context section, make sure to include alternatives to the decision being made and explain why the decision needs to be made in the first place. If this information is missing, you should ask the user to provide it.
Can I use this skill for all types of architecture decisions?
Yes, this skill is intended for all architecture decisions but requires that the user follow the structured format provided. The skill helps document the decision, context, options, and consequences in a standardized way.
Install record-adr
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
wmeints/promptyard