create-architectural-decision-record
github/awesome-copilot
Generate structured Architectural Decision Records optimized for AI parsing and team reference.
What is create-architectural-decision-record?
Creates standardized ADR documents that capture architectural decisions with context, alternatives, and consequences. Use this when you need to document significant technical choices in a format that's both machine-parseable and human-readable.
- Generates ADR documents with YAML front matter and structured markdown sections
- Validates required inputs (Context, Decision, Alternatives, Stakeholders) before proceeding
- Applies coded bullet points (3-4 letter codes + 3-digit numbers) for multi-item sections
- Saves files to /docs/adr/ with sequential naming convention (adr-NNNN-title-slug.md)
- Documents positive and negative consequences with explicit trade-offs
- Includes alternatives considered with rejection rationale
How to install create-architectural-decision-record
npx skills add https://github.com/github/awesome-copilot --skill create-architectural-decision-recordHow to use create-architectural-decision-record
- 1.Provide the decision title when prompted
- 2.Supply the Context describing the problem statement and constraints
- 3.Describe the Decision chosen and its rationale
- 4.List Alternatives considered with brief descriptions
- 5.Identify Stakeholders involved in or affected by the decision
- 6.Review the generated ADR file in /docs/adr/ and adjust status/dates as needed
Use cases
- Documenting database technology selection decisions for a team
- Recording architectural choices when migrating to microservices
- Capturing API design decisions with stakeholder context
- Documenting infrastructure or deployment strategy changes
- Creating audit trail of major technical decisions for compliance or knowledge transfer
- Software architects and technical leads
- Engineering teams making significant architectural choices
- Organizations requiring decision documentation for compliance or governance
- Teams using AI-assisted development workflows
create-architectural-decision-record FAQ
Include the problem statement, technical constraints, business requirements, and environmental factors that necessitate the decision. This provides the background needed to understand why the decision was necessary.
Each alternative includes a description and explicit rejection reason using coded bullet points (ALT-001, ALT-002, etc.). This helps readers understand why other options were not selected.
Status tracks the ADR lifecycle: Proposed (under consideration), Accepted (approved), Rejected (not chosen), Superseded (replaced by newer ADR), or Deprecated (no longer relevant).
Yes, use the 'supersedes' and 'superseded_by' fields in the front matter to link ADRs, and include related ADRs in the References section using REF codes.
Use the next sequential 4-digit number in the /docs/adr/ directory. The skill will help identify the correct number based on existing files.
Full instructions (SKILL.md)
Source of truth, from github/awesome-copilot.
name: create-architectural-decision-record description: 'Create an Architectural Decision Record (ADR) document for AI-optimized decision documentation.'
Create Architectural Decision Record
Create an ADR document for ${input:DecisionTitle} using structured formatting optimized for AI consumption and human readability.
Inputs
- Context:
${input:Context} - Decision:
${input:Decision} - Alternatives:
${input:Alternatives} - Stakeholders:
${input:Stakeholders}
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]
Related skills
More from github/awesome-copilot and the wider catalog.
git-commit
Execute semantic git commits with conventional message analysis and intelligent staging.
excalidraw-diagram-generator
Generate Excalidraw diagrams from natural language descriptions.
documentation-writer
Create structured technical documentation using the Diátaxis framework for tutorials, how-to guides, references, and explanations.
gh-cli
GitHub CLI comprehensive reference for repositories, issues, PRs, Actions, projects, releases, and all GitHub operations from the command line.
prd
Generate comprehensive Product Requirements Documents with executive summaries, user stories, technical specs, and risk analysis.
refactor
Surgical code refactoring to improve maintainability without changing behavior.