create-architectural-decision-record
Skill1k starsChanged 11 days agoMITView on GitHub
Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation. Use when the user asks to record an architectural decision, or when a change makes a decision worth recording under `docs/adr/`.
We split this skill into the rules it gives an agent
6 rules. 6 are common, 0 are distinctive, and 0 are very specific to this project.
6
Common
Most of the 5 edited versions we read keep these.
0
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Common: line 12
Create an ADR document for the decision the user describes, using structured formatting optimized for AI consumption and human readability.
- Common: line 25
If any of the required inputs are not provided or cannot be determined from the conversation history, ask the user to provide the missing …
- Common: line 29
Use precise, unambiguous language
- Common: line 30
Follow standardized ADR format with front matter
- Common: line 32
Document alternatives with rejection rationale
- Common: line 34
Use coded bullet points (3-4 letter codes + 3-digit numbers) for multi-item sections
“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Create Architectural Decision Record
Create an ADR document for the decision the user describes, using structured formatting optimized for AI consumption and human readability.
Inputs
Gather these from the request and the conversation:
- Decision Title: a short name for the decision
- Context: the problem and the constraints behind it
- Decision: the chosen solution
- Alternatives: the options considered and why each was rejected
- Stakeholders: who made the decision or is affected by it
Input Validation
If any of the required inputs are not provided or cannot be determined from the conversation history, ask the user to provide the missing information before proceeding with ADR generation.
Requirements
- Use precise, unambiguous language
- Follow standardized ADR format with front matter
- Include both positive and negative consequences
- Document alternatives with rejection rationale
- Structure for machine parsing and human reference
- Use coded bullet points (3-4 letter codes + 3-digit numbers) for multi-item sections
The ADR must be saved in the /docs/adr/ directory using the naming convention: adr-NNNN-[title-slug].md, where NNNN is the next sequential 4-digit number (e.g., adr-0001-database-selection.md).
Required Documentation Structure
The documentation file must follow the template below, ensuring that all sections are filled out appropriately. The front matter for the markdown should be structured correctly as per the example following:
---
title: "ADR-NNNN: [Decision Title]"
status: "Proposed"
date: "YYYY-MM-DD"
authors: "[Stakeholder Names/Roles]"
tags: ["architecture", "decision"]
supersedes: ""
superseded_by: ""
---
# ADR-NNNN: [Decision Title]
## Status
**Proposed** | Accepted | Rejected | Superseded | Deprecated
## Context
[Problem statement, technical constraints, business requirements, and environmental factors requiring this decision.]
## Decision
[Chosen solution with clear rationale for selection.]
## Consequences
### Positive
- **POS-001**: [Beneficial outcomes and advantages]
- **POS-002**: [Performance, maintainability, scalability improvements]
- **POS-003**: [Alignment with architectural principles]
### Negative
- **NEG-001**: [Trade-offs, limitations, drawbacks]
- **NEG-002**: [Technical debt or complexity introduced]
- **NEG-003**: [Risks and future challenges]
## Alternatives Considered
### [Alternative 1 Name]
- **ALT-001**: **Description**: [Brief technical description]
- **ALT-002**: **Rejection Reason**: [Why this option was not selected]
### [Alternative 2 Name]
- **ALT-003**: **Description**: [Brief technical description]
- **ALT-004**: **Rejection Reason**: [Why this option was not selected]
## Implementation Notes
- **IMP-001**: [Key implementation considerations]
- **IMP-002**: [Migration or rollout strategy if applicable]
- **IMP-003**: [Monitoring and success criteria]
## References
- **REF-001**: [Related ADRs]
- **REF-002**: [External documentation]
- **REF-003**: [Standards or frameworks referenced]Other versions5 projects use a version of this.
Word for word · 0
None found.
Edited · 5
- github/awesome-copilot★ 41k92% same
- jmrplens/gitlab-mcp-server★ 4590% same
- MarieLynneBlock/arcanum-artifex★ 487% same
- AgnesAI-Labs/agnet-skills-cn★ 173% same
- ReaperOAK/ForgeOS★ 092% same
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository12 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- boundaries-architectSkill
- create-issueSkill
- create-prSkill
- documentation-writerSkill
- releaseSkill
- repo-architectureSkill
- review-prSkill
- unit-testingSkill
- write-planSkill
- writing-styleSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

