adr-skill

Create and maintain Architecture Decision Records (ADRs) optimized for agentic coding workflows. Use when you need to propose, write, update, accept/reject, deprecate, or supersede an ADR; bootstrap an adr folder and index; consult existing ADRs before implementing changes; or enforce ADR conventions. This skill uses Socratic questioning to capture intent before drafting, and validates output against an agent-readiness checklist.

Install
npx skills add 'https://github.com/vercel/ai/tree/main/skills/adr-skill'
Download bundle ↓
main · 8b92ba9Scanned 2026-09-15

Contributors

GitHub-linked commit authors for this SKILL.md at the saved revision. Co-authors and history before file renames are not included.

File history ↗
View on GitHub
← Back to SKILL.md

Template Variants

This skill ships two templates in assets/templates/.

Simple

File: assets/templates/adr-simple.md

Use this when:

  • The decision is straightforward (one clear winner, minimal tradeoffs)
  • You mainly need "why, what, consequences, how to implement"
  • Alternatives are few and can be dismissed in a sentence each
  • Speed matters more than exhaustive comparison

Sections: Context and Problem Statement → Decision → Consequences → Implementation Plan → Verification → Alternatives Considered (optional) → More Information (optional).

MADR (Options-Heavy)

File: assets/templates/adr-madr.md

Use this when:

  • You have multiple real options and want to document structured tradeoffs
  • You need to capture decision drivers explicitly (what criteria mattered)
  • The decision is likely to be revisited and the comparison needs to survive
  • Stakeholders need to see the reasoning process, not just the outcome

Sections: Context and Problem Statement → Decision Drivers (optional) → Considered Options → Decision Outcome → Consequences → Implementation Plan → Verification → Pros and Cons of the Options (optional) → More Information (optional).

This template aligns with MADR 4.0 and extends it with agent-first sections.

Both Templates Share

  • YAML front matter for metadata (status, date, decision-makers, consulted, informed)
  • Implementation Plan — affected paths, dependencies, patterns to follow/avoid, configuration, migration steps. This is what makes the ADR an executable spec for agents.
  • Verification as checkboxes — testable criteria an agent can validate after implementation
  • Agent-first framing: placeholder text prompts you to be specific, measurable, and self-contained
  • "More Information" section for cross-links, follow-ups, and revisit triggers
  • "Neutral, because..." as a third argument category alongside Good and Bad

Choosing Between Them

SignalUse SimpleUse MADR
Number of real options1–23+
Team size affectedSmall / soloCross-team
ReversibilityEasily reversedHard to undo
Expected lifetimeMonthsYears
Needs stakeholder reviewNoYes

When in doubt, start with Simple. You can always expand to MADR if the discussion reveals more complexity.

Referenced from SKILL.md