doc-adr

Generate Architecture Decision Records using the Y-statement template.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/sunLeee/optimization --skill doc-adr-sunleee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-adr
Source: https://github.com/sunLeee/optimization/tree/main/.claude/skills/scaffolding/docs/doc-adr
Command: npx skills add https://github.com/sunLeee/optimization --skill doc-adr-sunleee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture decisions are often scattered, ambiguous, or hard to trace. This Skill creates Architecture Decision Records (ADRs) in a consistent format using the Y-statement structure to capture context, choices, and outcomes.

Core Features & Use Cases

  • Y-statement ADRs: Structure decisions with context, alternatives, decision, and consequences.
  • Linked ADRs & References: Maintain traceability across related architectural decisions and documents.
  • Lifecycle & Versioning: Track status changes (Proposed, Accepted, Deprecated, Superseded) and history.

Quick Start

Create a new ADR document with the given title using the Y-statement format.

Frequently Asked Questions about doc-adr

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is a Y-statement architecture decision record?

An architecture decision record (ADR) documents an architectural choice and its context. The Y-statement format structures this by capturing alternatives, the decision, and consequences for clear project traceability.

How do I write an architecture decision record using the Y-statement format?

To write an architecture decision record, provide a title and context. The Y-statement format structures the body with alternatives, the decision, consequences, and optional linked references for traceability.

How do I track the lifecycle and status of architectural decisions?

You track the lifecycle of architectural decisions by using versioned status tracking within the decision record. This monitors state changes like Proposed, Accepted, Deprecated, or Superseded alongside the change history.

Can I link related architecture decisions for better traceability?

Yes, you can link related architecture decisions. The Y-statement decision record format supports optional linked references to maintain traceability across related documents and architectural contexts.

Do I need a specific format for my architecture decision record files?

Yes, architecture decision record files require YAML frontmatter with name and description in SKILL.md, followed by a structured body following the Y-statement template to capture the architectural choice.