adr-writing

Document architecture decisions with ADR-NNN IDs and lifecycle states.

1|Updated Nov 29, 2025
One-click install
npx skills add https://github.com/SSiertsema/claude-code-plugins --skill adr-writing-ssiertsema
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-writing
Source: https://github.com/SSiertsema/claude-code-plugins/tree/main/adr-writing/skills/adr-writing
Command: npx skills add https://github.com/SSiertsema/claude-code-plugins --skill adr-writing-ssiertsema

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture decisions require traceability and immutability to prevent knowledge erosion. This ADR writing skill provides a structured workflow for recording, reviewing, superseding, and indexing architectural decisions.

Core Features & Use Cases

  • Supports Michael Nygard format (ADR-NNN) or Y-statement format for concise decisions.
  • Enforces immutability of accepted ADRs and explicit supersession chains to preserve history.
  • Provides lifecycle management: write, review, supersede, and index with an ADR index/log.

Quick Start

Write a new ADR with a clear subject, selecting the default Nygard format, and update the ADR index as decisions evolve.

Frequently Asked Questions about adr-writing

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

FAQPage Schema
How do I document architecture decisions to preserve rationale and history?

You can document architecture decisions using a structured ADR log that enforces stable IDs (ADR-NNN), immutability for accepted records, and explicit supersession chains to maintain full traceability and prevent knowledge erosion.

What is the difference between Michael Nygard and Y-statement formats for architecture decision records?

Architecture decision records using the Michael Nygard format provide full narrative context with standard sections, while the Y-statement format offers a concise structure for capturing decisions quickly. Both formats support lifecycle states like Proposed, Accepted, Deprecated, and Superseded.

How do I supersede an accepted architecture decision without losing the original context?

To supersede an accepted architecture decision, you create a new ADR with a new stable ID that explicitly references the old record, updating the ADR index/log so the original remains immutable and the supersession chain preserves the historical rationale.

Does this ADR workflow support lifecycle states like Proposed, Accepted, and Deprecated?

Yes, the ADR workflow supports full lifecycle management across Proposed, Accepted, Deprecated, and Superseded states, providing a guided process for write, review, supersede, and index operations to track decision evolution.

When do I need formal architecture decision records in my software project?

You need formal architecture decision records in projects requiring traceability and immutability to prevent knowledge erosion, especially when multiple teams must understand, review, or supersede structural decisions over time.

How do I maintain an ADR index log as architecture decisions evolve over time?

You maintain an ADR index log by using a frontmatter-driven entry point that automatically tracks decision states and supersession chains, ensuring the index updates accurately as you write, review, or supersede records.