Catalog
affaan-m/architecture-decision-records

affaan-m

architecture-decision-records

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.

global
origin:ECC
New~1.7k
v1.2Saved Jul 14, 2026

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:

  1. Initialize (first time only) — if docs/adr/ does not exist, ask the user for confirmation before creating the directory, a README.md seeded with the index table header (see ADR Index Format below), and a blank template.md for manual use. Do not create files without explicit consent.
  2. Identify the decision — extract the core architectural choice being made
  3. Gather context — what problem prompted this? What constraints exist?
  4. Document alternatives — what other options were considered? Why were they rejected?
  5. State consequences — what are the trade-offs? What becomes easier/harder?
  6. Assign a number — scan existing ADRs in docs/adr/ and increment
  7. Confirm and write — present the draft ADR to the user for review. Only write to docs/adr/NNNN-decision-title.md after explicit approval. If the user declines, discard the draft without writing any files.
  8. Update the index — append to docs/adr/README.md

Reading Existing ADRs

When a user asks "why did we choose X?":

  1. Check if docs/adr/ exists — if not, respond: "No ADRs found in this project. Would you like to start recording architectural decisions?"
  2. If it exists, scan docs/adr/README.md index for relevant entries
  3. Read matching ADR files and present the Context and Decision sections
  4. 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
Files1
1 files · 1.0 KB

Select a file to preview

Overall Score

84/100

Grade

B

Good

Safety

88

Quality

86

Clarity

85

Completeness

78

Summary

This skill guides agents to capture architectural decisions as structured ADR (Architecture Decision Record) documents during coding sessions. It detects decision moments, gathers context and alternatives, and generates lightweight, numbered ADR files in a project's `docs/adr/` directory. The skill also enables reading existing ADRs to answer "why did we choose X?" questions.

Detected Capabilities

file readfile writedirectory creationtext generationpattern matching

Trigger Keywords

Phrases that MCP clients use to match this skill to user intent.

record architecture decisiondocument framework choiceadr this decisionwhy did we choosecapture rationale

Risk Signals

INFO

Directory creation (docs/adr/) requires explicit user confirmation before write

Workflow > Capturing a New ADR, step 1
INFO

File writes only occur after draft review and explicit user approval

Workflow > Capturing a New ADR, step 7
INFO

Skill scoped to docs/adr/ directory — no writes outside project documentation structure

ADR Directory Structure section

Use Cases

  • Record framework or library choices with full context and alternatives
  • Document database design decisions and schema trade-offs
  • Capture API design decisions (REST vs GraphQL, versioning, auth)
  • Answer future developer questions about architectural rationale
  • Create an auditable log of technology choices across the codebase lifetime
  • Integrate ADR creation into planning and code review workflows

Quality Notes

  • Excellent scaffolding: provides concrete format template with examples (Michael Nygard ADR style adapted for AI use)
  • Clear decision detection signals distinguish explicit user intent from implicit suggestions, preventing premature auto-creation
  • Strong safety guardrails: requires confirmation before creating directories and explicit approval before writing ADR files
  • Well-structured workflow with numbered steps from detection through confirmation to write and index update
  • Comprehensive ADR index format with markdown table for easy navigation
  • Good lifecycle documentation showing proposed → accepted → deprecated/superseded state machine
  • Practical category table helps users identify what decisions are worth recording
  • Some ambiguity in 'Confirm and write' step — does agent show draft to user before writing, or does user confirm verbally first? Clarify the review UX
  • ADR numbering strategy (scan existing files and increment) is sound but could document how to handle concurrent ADR creation
  • Integration hints with other skills (planner, code reviewer) are forward-looking but not fully actionable within this skill alone
Model: claude-haiku-4-5-20251001Analyzed: Jul 14, 2026

Reviews

Add this skill to your library to leave a review.

No reviews yet

Be the first to share your experience.

Version History

v1.2

Content updated

2026-07-14

Latest
v1.1

Content updated

2026-04-20

v1.0

No changelog

2026-04-12

Use affaan-m/architecture-decision-records in your dev environment

Command Palette

Search for a command to run...