create-adr
Detects architectural decisions in conversation and guides creation of Architecture Decision Records. Activate when the user is making, discussing, or debating: technology choices (languages, frameworks, databases, cloud services), structural patterns (monolith vs microservices, event-driven, CQRS, API design), cross-cutting conventions (error handling, logging, authentication, API versioning), hard-to-reverse decisions (data models, public API contracts, infrastructure topology), or deviations from existing standards. Also activate when the user explicitly asks to create an ADR.
ADR Lifecycle
PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)
- New ADRs always start as
PROPOSED— including ADRs that supersede an existing one. Never set a new ADR toACCEPTED. - For material changes to a decision, write a new ADR that
supersedes the old one. The new ADR's status is
PROPOSED. Update the old ADR's status toSUPERSEDEDand link to the new one. - Minor corrections (typos, missing details) can be edited in place.
Workflow
-
Detect — An architectural decision is in play.
-
Propose — Ask the user: "This looks like an architectural decision. Would you like to record it as an ADR?" If this is the first ADR in the session, also ask: "Would you like me to walk through the details one question at a time, or should I draft it from what I already know?"
-
Explore the codebase — Before asking the user anything, gather what you can on your own:
- Read existing ADRs in
docs/adr/for related or superseded decisions - Check the tech stack (package.json, go.mod, requirements.txt, etc.)
- Find code patterns related to the decision area
- Identify affected files and existing conventions
Don't ask the user what you can look up yourself.
- Read existing ADRs in
-
Gather context — Collect what you couldn't find in the codebase. For each question, provide your recommended answer with justification based on what you found in step 3. Let the user confirm or correct. Collect: the core decision, key decision drivers, rationale, alternatives with pros/cons/rejection reasons, consequences (positive, negative, neutral), non-goals, and relevant links.
-
Generate — Create the ADR using the template at assets/adr-template.md. Fill every section with real content — do not leave placeholder text. The ADR must include:
- YAML frontmatter with
status: PROPOSED,date, andauthors. Always set status toPROPOSED— neverACCEPTEDorDECIDED. This is non-negotiable even when the user has already decided. - Context explaining the problem and forces at play
- Decision drivers as a prioritized list
- The decision in active voice
- At least two alternatives with pros, cons, and rejection reasons
- Consequences split into positive, negative, and neutral
- Non-goals section if anything is explicitly out of scope (omit if none)
- Reversibility section if it's useful to note how to undo the decision or what would trigger reconsideration (omit if none)
- References section listing any links, related ADRs, or resources discovered during research (omit if none)
- YAML frontmatter with
-
Place the file — Save to
docs/adr/NNNN-<slug>.mdwhere:NNNNis the next sequential number (zero-padded to 4 digits)<slug>is a lowercase, hyphenated summary of the decision- Check existing files in
docs/adr/to determine the next number - Example:
docs/adr/0003-use-postgresql-for-persistence.md
-
Confirm — Show the user the generated ADR and ask if any adjustments are needed before finalizing.
-
Find blind spots — When the ADR is finalized, check if
grill-with-docsexists. If it does, ask: "Want me to grill this ADR against your domain language?" If yes, activate it. Ifgrill-with-docsdoesn't exist, trygrill-meinstead. If neither exists, skip silently.
Quality self-check (E.C.A.D.R.)
Before finalizing an ADR, verify:
- Explicit problem statement — Context makes the problem unambiguous
- Comprehensive options analysis — at least 2 alternatives with honest pros/cons
- Actionable decision — specific enough to act on, in active voice
- Documented consequences — positive, negative, and neutral impacts
- References included — any links from research are listed
For sections that cannot be filled from available data, insert investigation
prompts: [INVESTIGATE: description of what needs follow-up]
Match depth to complexity
Omit optional sections (Non-goals, Reversibility, References) when they add no information. A two-paragraph ADR for a straightforward choice is better than a bloated one.
When a decision directly maps to code changes, add an Implementation Plan section describing affected paths and patterns to follow.
Example Scenario
User: "Should we use Postgres or DynamoDB for the order service?"
- Skill detects a technology choice decision
- Asks: "This looks like an architectural decision. Want an ADR?"
- Reads existing ADRs, checks go.mod/package.json for current DB
- Drafts ADR with both options, pros/cons, and a recommendation
- Saves to
docs/adr/0007-use-postgresql-for-order-service.md
├── assets/
SKILL.md | | Raw
Create ADR
ADR Lifecycle
PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)
- New ADRs always start as
PROPOSED— including ADRs that supersede an existing one. Never set a new ADR toACCEPTED. - For material changes to a decision, write a new ADR that
supersedes the old one. The new ADR's status is
PROPOSED. Update the old ADR's status toSUPERSEDEDand link to the new one. - Minor corrections (typos, missing details) can be edited in place.
Workflow
-
Detect — An architectural decision is in play.
-
Propose — Ask the user: "This looks like an architectural decision. Would you like to record it as an ADR?" If this is the first ADR in the session, also ask: "Would you like me to walk through the details one question at a time, or should I draft it from what I already know?"
-
Explore the codebase — Before asking the user anything, gather what you can on your own:
- Read existing ADRs in
docs/adr/for related or superseded decisions - Check the tech stack (package.json, go.mod, requirements.txt, etc.)
- Find code patterns related to the decision area
- Identify affected files and existing conventions
Don't ask the user what you can look up yourself.
- Read existing ADRs in
-
Gather context — Collect what you couldn't find in the codebase. For each question, provide your recommended answer with justification based on what you found in step 3. Let the user confirm or correct. Collect: the core decision, key decision drivers, rationale, alternatives with pros/cons/rejection reasons, consequences (positive, negative, neutral), non-goals, and relevant links.
-
Generate — Create the ADR using the template at assets/adr-template.md. Fill every section with real content — do not leave placeholder text. The ADR must include:
- YAML frontmatter with
status: PROPOSED,date, andauthors. Always set status toPROPOSED— neverACCEPTEDorDECIDED. This is non-negotiable even when the user has already decided. - Context explaining the problem and forces at play
- Decision drivers as a prioritized list
- The decision in active voice
- At least two alternatives with pros, cons, and rejection reasons
- Consequences split into positive, negative, and neutral
- Non-goals section if anything is explicitly out of scope (omit if none)
- Reversibility section if it's useful to note how to undo the decision or what would trigger reconsideration (omit if none)
- References section listing any links, related ADRs, or resources discovered during research (omit if none)
- YAML frontmatter with
-
Place the file — Save to
docs/adr/NNNN-<slug>.mdwhere:NNNNis the next sequential number (zero-padded to 4 digits)<slug>is a lowercase, hyphenated summary of the decision- Check existing files in
docs/adr/to determine the next number - Example:
docs/adr/0003-use-postgresql-for-persistence.md
-
Confirm — Show the user the generated ADR and ask if any adjustments are needed before finalizing.
-
Find blind spots — When the ADR is finalized, check if
grill-with-docsexists. If it does, ask: "Want me to grill this ADR against your domain language?" If yes, activate it. Ifgrill-with-docsdoesn't exist, trygrill-meinstead. If neither exists, skip silently.
Quality self-check (E.C.A.D.R.)
Before finalizing an ADR, verify:
- Explicit problem statement — Context makes the problem unambiguous
- Comprehensive options analysis — at least 2 alternatives with honest pros/cons
- Actionable decision — specific enough to act on, in active voice
- Documented consequences — positive, negative, and neutral impacts
- References included — any links from research are listed
For sections that cannot be filled from available data, insert investigation
prompts: [INVESTIGATE: description of what needs follow-up]
Match depth to complexity
Omit optional sections (Non-goals, Reversibility, References) when they add no information. A two-paragraph ADR for a straightforward choice is better than a bloated one.
When a decision directly maps to code changes, add an Implementation Plan section describing affected paths and patterns to follow.
Example Scenario
User: "Should we use Postgres or DynamoDB for the order service?"
- Skill detects a technology choice decision
- Asks: "This looks like an architectural decision. Want an ADR?"
- Reads existing ADRs, checks go.mod/package.json for current DB
- Drafts ADR with both options, pros/cons, and a recommendation
- Saves to
docs/adr/0007-use-postgresql-for-order-service.md
assets/adr-template.md | | Raw
NNNN. [Title — use imperative verb phrase, e.g. "Use PostgreSQL for persistence"]
Context
[What is the problem or opportunity? What forces are at play — technical, political, social, project-specific? Leave no room for ambiguity about why this decision was needed.]
Decision Drivers
- [Driver 1 — e.g., "Must support concurrent writes from multiple services"]
- [Driver 2 — e.g., "Team has no experience with technology X"]
- [Driver 3]
Decision
[State the decision clearly in active voice: "We will use X because…"]
Alternatives Considered
[Alternative 1]
- Pros: [advantages]
- Cons: [disadvantages]
- Rejected because: [specific reason]
[Alternative 2]
- Pros: [advantages]
- Cons: [disadvantages]
- Rejected because: [specific reason]
Consequences
Positive
- [What becomes easier or better]
Negative
- [What becomes harder or worse]
Neutral
- [Side effects that are neither clearly positive nor negative]
Non-goals
[Optional. What is explicitly out of scope for this decision? Stating non-goals prevents scope creep and tells agents what NOT to implement.]
Reversibility
[Optional. How would this decision be undone if needed? What conditions should trigger reconsideration?]
References
[Optional. Links discovered during research, related ADRs, prior art, or any external resources that informed this decision.]
create-adr detects architectural decisions in conversation and guides creation of Architecture Decision Records with a structured lifecycle.
Why ADRs always start as PROPOSED
Even when the user has clearly decided, starting as PROPOSED preserves the review workflow. Team members can challenge the decision before it becomes canon. Skipping to ACCEPTED removes that safety net.
Why the skill investigates the codebase before asking
Reading existing ADRs, the tech stack, and code patterns before questioning the user reduces interview fatigue. Most context already exists in the repo — asking for it wastes the user's time.
Why the E.C.A.D.R. quality check exists
A final self-check gate catches incomplete ADRs before they're committed. Without it, rushed sessions produce ADRs missing context or alternatives — defeating their purpose as future-reader documentation.
Why tiny single-paragraph ADRs are allowed
If every ADR requires five sections (Context, Drivers, Options, Decision, Consequences), the process feels heavy and people stop writing them entirely. Allowing a single paragraph that records what was decided and why removes that friction. A three-sentence ADR is infinitely more useful than no ADR at all.
[1.2.1] - 2026-06-11
Added
- RATIONALE.md explaining design decisions
[1.2.0] - 2026-05-24
Added
- Workflow step 8: offer to run grill-me skill on finalized ADRs to find blind spots
[1.1.0] - 2026-04-30
Added
- Example scenario showing end-to-end ADR creation flow
- Gotcha: never leave placeholder text in sections
- references/ACKNOWLEDGMENTS.md for source attribution
Changed
- Moved References to references/ACKNOWLEDGMENTS.md
- Merged Common Failures into Gotchas to reduce overlap with E.C.A.D.R. quality checklist
Removed
- "When to suggest" section (duplicated the description)
- Inline References section (moved to ACKNOWLEDGMENTS.md)
[1.0.2] - 2026-04-26
Fixed
- Applied markdown-consistency rule: added language specifier to code block, blank lines around headings in changelog
[1.0.1] - 2026-04-25
Changed
- Trimmed intro paragraphs redundant with description
- Compacted "When to suggest" list for conciseness
Fixed
- CHANGELOG.md formatting (added missing category header)
[1.0.0] - 2026-04-12
Added
- Customized Nygard ADR template with YAML frontmatter, decision drivers, structured alternatives, and categorized consequences
- Optional Non-goals, Reversibility, and References sections
- Workflow: codebase exploration before asking questions
- Workflow: recommend answers with justification
- Workflow: one-at-a-time mode for first ADR in session
- E.C.A.D.R. quality self-check with INVESTIGATE markers
- ADR lifecycle: PROPOSED → ACCEPTED → SUPERSEDED/DEPRECATED
- Documenting Architecture Decisions — Michael Nygard's original ADR proposal, basis for the template format (adopted in v1.0.0)
- MADR — Markdown Any Decision Records, source of Decision Drivers section (adopted in v1.0.0)
- adr.github.io — Community resources, tooling, and template variations (adopted in v1.0.0)