architecture-decision-record
yonatangross/orchestkit
Nygard-format ADR templates for documenting architectural decisions with context, consequences, and alternatives.
What is architecture-decision-record?
This skill provides templates and best practices for creating Architecture Decision Records (ADRs) that capture important technical choices along with their rationale and trade-offs. Use it when making significant architectural decisions, evaluating options, or documenting decisions that will impact future development.
- Generate ADRs using the Nygard format with auto-filled metadata (number, date, author)
- Document decision context, chosen solution, consequences, and alternatives considered
- Maintain immutable decision records in version control with sequential numbering
- Track ADR lifecycle from Proposed through Accepted, Implemented, Superseded, or Deprecated
- Analyze trade-offs between architectural options with structured comparison
- Preserve architectural rationale for onboarding and preventing decision revisits
How to install architecture-decision-record
npx skills add https://github.com/yonatangross/orchestkit --skill architecture-decision-recordHow to use architecture-decision-record
- 1.Run the ADR generator script with `/create-adr [number] [title]` to auto-populate metadata
- 2.Fill in the Context section with problem statement, constraints, and stakeholder requirements
- 3.Write the Decision section specifying what will change and who is responsible
- 4.Document Consequences covering both positive outcomes and trade-offs
- 5.Describe at least 2 Alternatives Considered, explaining why each was rejected
- 6.Set Status to 'Proposed' and review with relevant stakeholders before approval
- 7.Update Status to 'Accepted' after team approval and commit to version control
Use cases
- Documenting a choice between microservices vs. monolithic architecture
- Recording a database selection decision (PostgreSQL vs. MongoDB) with trade-off analysis
- Capturing why a team adopted Kubernetes for container orchestration
- Evaluating cloud provider options and documenting the chosen platform
- Creating a decision record for API design patterns or authentication approaches
- Backend architects and system designers
- Engineering teams establishing architectural standards
- Technical leads reviewing and approving major decisions
- New team members learning system rationale and design history
- Organizations building decision audit trails for compliance
architecture-decision-record FAQ
Write an ADR for significant technology choices (databases, frameworks, cloud providers), major architectural changes, new patterns or conventions, and decisions that will impact future development. Avoid ADRs for minor implementation details.
No. ADRs are immutable historical records. If a decision changes, create a new ADR that supersedes the old one, referencing the original ADR number.
Superseded means a later ADR replaced this decision with a new choice. Deprecated means the decision is no longer recommended but hasn't been formally replaced yet.
Include positive outcomes (benefits), negative outcomes (costs and risks), and neutral outcomes (things that change but aren't clearly better or worse). Be honest about trade-offs, not just marketing benefits.
Keep ADRs in version control alongside code, typically in `/docs/adr/` or `/architecture/decisions/` directories, formatted as Markdown files with sequential numbering like ADR-0001.md.
Full instructions (SKILL.md)
Source of truth, from yonatangross/orchestkit.
name: architecture-decision-record license: MIT compatibility: "Claude Code 2.1.277+." description: ADR templates in the Nygard format with context, decision, consequences, and alternatives. Use when writing ADRs, recording an architectural decision, or evaluating options. context: fork agent: backend-system-architect user-invocable: false metadata: category: document-asset-creation version: "2.0.0" author: "OrchestKit" complexity: "medium" tags: "architecture, documentation, decision-making, backend" allowed-tools:
- Read
- Glob
- Grep
- WebFetch
- WebSearch
Architecture Decision Records
Architecture Decision Records (ADRs) are lightweight documents that capture important architectural decisions along with their context and consequences. This skill provides templates, examples, and best practices for creating and maintaining ADRs in your projects.
Overview
- Making significant technology choices (databases, frameworks, cloud providers)
- Designing system architecture or major components
- Establishing patterns or conventions for the team
- Evaluating trade-offs between multiple approaches
- Documenting decisions that will impact future development
Why ADRs Matter
ADRs serve as architectural memory for your team:
- Context Preservation: Capture why decisions were made, not just what was decided
- Onboarding: Help new team members understand architectural rationale
- Prevent Revisiting: Avoid endless debates about settled decisions
- Track Evolution: See how architecture evolved over time
- Accountability: Clear ownership and decision timeline
ADR Format (Nygard Template)
Each ADR should follow this structure:
1. Title
Format: ADR-####: [Decision Title]
Example: ADR-0001: Adopt Microservices Architecture
2. Status
Current state of the decision:
- Proposed: Under consideration
- Accepted: Decision approved and being implemented
- Superseded: Replaced by a later decision (reference ADR number)
- Deprecated: No longer recommended but not yet replaced
- Rejected: Considered but not adopted (document why)
3. Context
What to include:
- Problem statement or opportunity
- Business/technical constraints
- Stakeholder requirements
- Current state of the system
- Forces at play (conflicting concerns)
4. Decision
What to include:
- The choice being made
- Key principles or patterns to follow
- What will change as a result
- Who is responsible for implementation
Be specific and actionable:
- ✅ "We will adopt microservices architecture using Node.js with Express"
- ❌ "We will consider using microservices"
5. Consequences
What to include:
- Positive outcomes (benefits)
- Negative outcomes (costs, risks, trade-offs)
- Neutral outcomes (things that change but aren't clearly better/worse)
6. Alternatives Considered
Document at least 2 alternatives:
For each alternative, explain:
- What it was
- Why it was considered
- Why it was not chosen
7. References (Optional)
Links to relevant resources:
- Meeting notes or discussion threads
- Related ADRs
- External research or articles
- Proof of concept implementations
ADR Lifecycle
Proposed → Accepted → [Implemented] → (Eventually) Superseded/Deprecated
↓
Rejected
Best Practices
1. Keep ADRs Immutable
Once accepted, don't edit ADRs. Create new ADRs that supersede old ones.
- ✅ Create ADR-0015 that supersedes ADR-0003
- ❌ Update ADR-0003 with new decisions
2. Write in Present Tense
ADRs are historical records written as if the decision is being made now.
- ✅ "We will adopt microservices"
- ❌ "We adopted microservices"
3. Focus on 'Why', Not 'How'
ADRs capture decisions, not implementation details.
- ✅ "We chose PostgreSQL for relational consistency"
- ❌ "Configure PostgreSQL with these specific settings..."
4. Review ADRs as Team
Get input from relevant stakeholders before accepting.
- Architects: Technical viability
- Developers: Implementation feasibility
- Product: Business alignment
- DevOps: Operational concerns
5. Number Sequentially
Use 4-digit zero-padded numbers: ADR-0001, ADR-0002, etc. Maintain a single sequence even with multiple projects.
6. Store in Git
Keep ADRs in version control alongside code:
- Location:
/docs/adr/or/architecture/decisions/ - Format: Markdown for easy reading
- Branch: Same branch as implementation
Quick Start Checklist
Option 1: Use Script-Enhanced Generator (Recommended)
- Run
/create-adr [number] [title]to generate ADR with auto-filled context - ADR number, date, and author are auto-populated
- Review and fill in decision details
- Set Status to "Proposed" and review with team
Option 2: Use Static Template
- Copy ADR template from
assets/adr-template.md - Assign next sequential number (check existing ADRs)
- Fill in Context: problem, constraints, requirements
- Document Decision: what, why, how, who
- List Consequences: positive, negative, neutral
- Describe at least 2 Alternatives: what, pros/cons, why not chosen
- Add References: discussions, research, related ADRs
- Set Status to "Proposed"
- Review with team
- Update Status to "Accepted" after approval
- Link ADR in implementation PR
- Update Status to "Implemented" after deployment
Available Scripts
-
scripts/create-adr.md- Dynamic ADR generator with auto-filled context- Auto-fills: ADR number, date, author, total ADRs count
- Usage:
/create-adr [number] [title] - Uses
$ARGUMENTSand!commandfor dynamic context
-
assets/adr-template.md- Static template for manual use
Rules Quick Reference
| Rule | Impact | What It Covers |
|---|---|---|
| interrogation-scalability | HIGH | Scale questions, data volume, growth projections |
| interrogation-reliability | HIGH | Data patterns, UX impact, coherence validation |
| interrogation-security | HIGH | Access control, tenant isolation, attack surface |
Common Pitfalls to Avoid
❌ Too Technical: "We'll use Kubernetes with these 50 YAML configs..." ✅ Right Level: "We'll use Kubernetes for container orchestration because..."
❌ Too Vague: "We'll use a better database" ✅ Specific: "We'll use PostgreSQL 15+ for transactional data because..."
❌ No Alternatives: Only documenting the chosen solution ✅ Comparative: Document why alternatives weren't chosen
❌ Missing Consequences: Only listing benefits ✅ Balanced: Honest about costs and trade-offs
❌ No Context: "We decided to use Redis" ✅ Contextual: "Given our 1M+ concurrent users and sub-50ms latency requirement..."
Related Skills
ork:api-design: Use when designing APIs referenced in ADRsork:database-patterns: Use when ADR involves database choices- security-checklist: Consult when ADR has security implications
Skill Version: 2.0.0 Last Updated: 2026-01-08 Maintained by: OrchestKit
Capability Details
adr-creation
Keywords: adr, architecture decision, decision record, document decision Solves:
- How do I document an architectural decision?
- Create an ADR
- Architecture decision template
adr-best-practices
Keywords: when to write adr, adr lifecycle, adr workflow, adr process, adr review, quantify impact Solves:
- When should I write an ADR?
- How do I manage ADR lifecycle?
- What's the ADR review process?
- How to quantify decision impact?
- ADR anti-patterns to avoid
- Link related ADRs
tradeoff-analysis
Keywords: tradeoff, pros cons, alternatives, comparison, evaluate options Solves:
- How do I analyze tradeoffs?
- Compare architectural options
- Document alternatives considered
consequences
Keywords: consequence, impact, risk, benefit, outcome Solves:
- What are the consequences of this decision?
- Document decision impact
- Risk and benefit analysis
Related skills
More from yonatangross/orchestkit and the wider catalog.

devops-deployment
CI/CD pipelines, containerization, Kubernetes, and infrastructure-as-code patterns for DevOps workflows.

domain-driven-design
DDD tactical patterns for rich domain modeling with entities, value objects, and aggregates.

memory
Unified read-side memory operations including knowledge graph search, session context loading, decision timeline viewing, and Mermaid graph visualization. Subcommands: search, load, history, viz, status. Complements /ork:remember (write-side). Use when searching past decisions, loading context, or visualizing the knowledge graph.

rag-retrieval
Production RAG patterns: embeddings, hybrid search, reranking, HyDE, agentic retrieval, and pgvector indexing.

responsive-patterns
Container queries, fluid typography, and mobile-first patterns for responsive React layouts.

security-patterns
Security patterns for authentication, defense-in-depth, input validation, OWASP Top 10, LLM safety, and PII masking. Use when implementing auth flows, security layers, input sanitization, vulnerability prevention, prompt injection defense, or data redaction.