architecture-decision-records
affaan-m/everything-claude-code
Auto-capture architectural decisions as structured ADRs during coding sessions.
What is architecture-decision-records?
This skill detects architectural decision moments during Claude Code sessions and records them as structured Architecture Decision Records (ADRs). Use it when choosing between significant alternatives like frameworks, databases, or patterns to create a living record of why your codebase is shaped the way it is.
- Auto-detects decision moments from conversation patterns and explicit signals
- Generates structured ADR documents with context, decision, alternatives, and consequences
- Maintains a searchable ADR index in docs/adr/README.md
- Reads existing ADRs to answer "why did we choose X?" questions
- Assigns sequential numbering and manages ADR lifecycle (proposed/accepted/superseded)
- Initializes ADR directory structure with templates and index on first use
How to install architecture-decision-records
npx skills add https://github.com/affaan-m/everything-claude-code --skill architecture-decision-recordsHow to use architecture-decision-records
- 1.Trigger the skill by saying "let's record this decision" or "ADR this" during a decision discussion
- 2.Provide context about the problem, constraints, and alternatives being considered
- 3.Review the generated ADR draft covering decision title, context, alternatives, and consequences
- 4.Approve the ADR to write it to docs/adr/NNNN-decision-title.md and update the index
- 5.Query existing ADRs by asking "why did we choose X?" to read past decisions
Use cases
- Recording a choice between Next.js and Vue.js during frontend planning
- Documenting why PostgreSQL was selected over MongoDB for the primary datastore
- Capturing the rationale for choosing REST API over GraphQL with trade-offs
- Answering future questions about why a specific authentication strategy was adopted
- Tracking deprecated decisions and linking to their replacements when architecture evolves
- Development teams building shared context around architectural choices
- Projects that need to onboard new developers quickly with decision history
- Teams practicing decision-driven development and architectural governance
- Codebases where "why" questions about design choices come up repeatedly
architecture-decision-records FAQ
Create an ADR when making significant architectural choices like selecting frameworks, databases, API designs, or patterns. Skip trivial decisions like variable naming or formatting. Watch for signals like "we should use X instead of Y" or explicit "record this decision" requests.
You can backfill ADRs for past decisions. Note the original decision date in the ADR and mark the status appropriately (usually "accepted"). The skill will assign the next sequential number.
Create a new ADR for the new decision and mark the old one as "superseded by ADR-NNNN". This preserves the history and explains why the original decision is no longer in effect.
Yes. The skill creates standard markdown files in docs/adr/ that you can edit directly. A template.md file is provided for manual ADR creation if you prefer to write them without the skill's guidance.
The skill will ask for confirmation before creating the docs/adr/ directory, README.md index, and template.md. It will not create files without explicit user consent.
Full instructions (SKILL.md)
Source of truth, from affaan-m/everything-claude-code.
name: architecture-decision-records description: Capture architectural decisions made during Claude Code sessions as structured ADRs. Auto-detects decision moments, records context, alternatives considered, and rationale. Maintains an ADR log so future developers understand why the codebase is shaped the way it is. metadata: origin: ECC
Architecture Decision Records
Capture architectural decisions as they happen during coding sessions. Instead of decisions living only in Slack threads, PR comments, or someone's memory, this skill produces structured ADR documents that live alongside the code.
When to Activate
- User explicitly says "let's record this decision" or "ADR this"
- User chooses between significant alternatives (framework, library, pattern, database, API design)
- User says "we decided to..." or "the reason we're doing X instead of Y is..."
- User asks "why did we choose X?" (read existing ADRs)
- During planning phases when architectural trade-offs are discussed
ADR Format
Use the lightweight ADR format proposed by Michael Nygard, adapted for AI-assisted development:
# ADR-NNNN: [Decision Title]
**Date**: YYYY-MM-DD
**Status**: proposed | accepted | deprecated | superseded by ADR-NNNN
**Deciders**: [who was involved]
## Context
What is the issue that we're seeing that is motivating this decision or change?
[2-5 sentences describing the situation, constraints, and forces at play]
## Decision
What is the change that we're proposing and/or doing?
[1-3 sentences stating the decision clearly]
## Alternatives Considered
### Alternative 1: [Name]
- **Pros**: [benefits]
- **Cons**: [drawbacks]
- **Why not**: [specific reason this was rejected]
### Alternative 2: [Name]
- **Pros**: [benefits]
- **Cons**: [drawbacks]
- **Why not**: [specific reason this was rejected]
## Consequences
What becomes easier or more difficult to do because of this change?
### Positive
- [benefit 1]
- [benefit 2]
### Negative
- [trade-off 1]
- [trade-off 2]
### Risks
- [risk and mitigation]
Workflow
Capturing a New ADR
When a decision moment is detected:
- Initialize (first time only) — if
docs/adr/does not exist, ask the user for confirmation before creating the directory, aREADME.mdseeded with the index table header (see ADR Index Format below), and a blanktemplate.mdfor manual use. Do not create files without explicit consent. - Identify the decision — extract the core architectural choice being made
- Gather context — what problem prompted this? What constraints exist?
- Document alternatives — what other options were considered? Why were they rejected?
- State consequences — what are the trade-offs? What becomes easier/harder?
- Assign a number — scan existing ADRs in
docs/adr/and increment - Confirm and write — present the draft ADR to the user for review. Only write to
docs/adr/NNNN-decision-title.mdafter explicit approval. If the user declines, discard the draft without writing any files. - Update the index — append to
docs/adr/README.md
Reading Existing ADRs
When a user asks "why did we choose X?":
- Check if
docs/adr/exists — if not, respond: "No ADRs found in this project. Would you like to start recording architectural decisions?" - If it exists, scan
docs/adr/README.mdindex for relevant entries - Read matching ADR files and present the Context and Decision sections
- If no match is found, respond: "No ADR found for that decision. Would you like to record one now?"
ADR Directory Structure
docs/
└── adr/
├── README.md ← index of all ADRs
├── 0001-use-nextjs.md
├── 0002-postgres-over-mongo.md
├── 0003-rest-over-graphql.md
└── template.md ← blank template for manual use
ADR Index Format
# Architecture Decision Records
| ADR | Title | Status | Date |
|-----|-------|--------|------|
| [0001](0001-use-nextjs.md) | Use Next.js as frontend framework | accepted | 2026-01-15 |
| [0002](0002-postgres-over-mongo.md) | PostgreSQL over MongoDB for primary datastore | accepted | 2026-01-20 |
| [0003](0003-rest-over-graphql.md) | REST API over GraphQL | accepted | 2026-02-01 |
Decision Detection Signals
Watch for these patterns in conversation that indicate an architectural decision:
Explicit signals
- "Let's go with X"
- "We should use X instead of Y"
- "The trade-off is worth it because..."
- "Record this as an ADR"
Implicit signals (suggest recording an ADR — do not auto-create without user confirmation)
- Comparing two frameworks or libraries and reaching a conclusion
- Making a database schema design choice with stated rationale
- Choosing between architectural patterns (monolith vs microservices, REST vs GraphQL)
- Deciding on authentication/authorization strategy
- Selecting deployment infrastructure after evaluating alternatives
What Makes a Good ADR
Do
- Be specific — "Use Prisma ORM" not "use an ORM"
- Record the why — the rationale matters more than the what
- Include rejected alternatives — future developers need to know what was considered
- State consequences honestly — every decision has trade-offs
- Keep it short — an ADR should be readable in 2 minutes
- Use present tense — "We use X" not "We will use X"
Don't
- Record trivial decisions — variable naming or formatting choices don't need ADRs
- Write essays — if the context section exceeds 10 lines, it's too long
- Omit alternatives — "we just picked it" is not a valid rationale
- Backfill without marking it — if recording a past decision, note the original date
- Let ADRs go stale — superseded decisions should reference their replacement
ADR Lifecycle
proposed → accepted → [deprecated | superseded by ADR-NNNN]
- proposed: decision is under discussion, not yet committed
- accepted: decision is in effect and being followed
- deprecated: decision is no longer relevant (e.g., feature removed)
- superseded: a newer ADR replaces this one (always link the replacement)
Categories of Decisions Worth Recording
| Category | Examples |
|---|---|
| Technology choices | Framework, language, database, cloud provider |
| Architecture patterns | Monolith vs microservices, event-driven, CQRS |
| API design | REST vs GraphQL, versioning strategy, auth mechanism |
| Data modeling | Schema design, normalization decisions, caching strategy |
| Infrastructure | Deployment model, CI/CD pipeline, monitoring stack |
| Security | Auth strategy, encryption approach, secret management |
| Testing | Test framework, coverage targets, E2E vs integration balance |
| Process | Branching strategy, review process, release cadence |
Integration with Other Skills
- Planner agent: when the planner proposes architecture changes, suggest creating an ADR
- Code reviewer agent: flag PRs that introduce architectural changes without a corresponding ADR
Related skills
More from affaan-m/everything-claude-code and the wider catalog.
security-review
Security checklist and patterns for authentication, input validation, secrets, and sensitive features.
golang-patterns
Idiomatic Go patterns, best practices, and conventions for building robust, efficient, and maintainable applications.
coding-standards
Baseline coding conventions for naming, readability, immutability, and quality across projects.
frontend-patterns
React and Next.js patterns for components, state management, performance, and modern frontend practices.
backend-patterns
REST/GraphQL API design, database optimization, and server-side patterns for Node.js, Express, and Next.js.
golang-testing
Go testing patterns: table-driven tests, subtests, benchmarks, fuzzing, and TDD methodology.