adr

Author Architecture Decision Records with the adr-shape 5-section convention.

2|Updated May 13, 2026
One-click install
npx skills add https://github.com/alexherrero/crickets --skill adr-alexherrero
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/alexherrero/crickets/tree/main/src/design-docs/skills/adr
Command: npx skills add https://github.com/alexherrero/crickets --skill adr-alexherrero

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The ADR process provides a standardized way to capture design decisions, rationale, and future audit notes so teams can reason about architecture changes over time.

Core Features & Use Cases

  • Enforces the canonical 5-section ADR shape (Context, Decision, Consequences, Related, Document History).
  • Guides re-audit triggers and change management so ADRs stay current as constraints evolve.
  • Supports per-project adoption and integration with existing design docs and governance.

Quick Start

Create a new ADR file following the 5-section shape and include explicit re-audit triggers.

Frequently Asked Questions about adr

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

FAQPage Schema
What is an Architecture Decision Record and why do I need one for my software project?

An Architecture Decision Record (ADR) captures design decisions, rationale, and future audit notes so teams can reason about architecture changes over time. It provides a standardized way to document trade-off analysis and change traceability across releases.

How do I write an ADR using the 5-section structure?

To write an ADR, author a file following the canonical 5-section shape: Context, Decision, Consequences, Related, and Document History. Ensure the frontmatter includes name, description, and versioning, while the body details explicit 'why not the alternative' reasoning.

When should I document a design decision versus just implementing the code change?

You should document a design decision whenever a software project requires formal decision documentation, trade-off analysis, or change traceability across releases. It is needed to ensure stakeholders can reason about architecture changes and constraints over time.

How do I keep architecture decision records current as project constraints evolve?

You keep architecture decision records current by guiding re-audit triggers and change management within the ADR. Including explicit re-audit triggers in the document ensures ADRs stay current and integrated with existing design docs and governance as constraints evolve.

What is the best way to document why an alternative architecture design was rejected?

The best way to document rejected alternatives is using the 5-section ADR structure, which enforces explicit 'why not the alternative' reasoning within the body. This ensures your trade-off analysis is formally captured alongside the final decision.

Does this ADR format work for per-project adoption and integration with existing design docs?

Yes, the ADR format supports per-project adoption and integration with existing design docs and governance. It enforces a standardized 5-section shape with frontmatter metadata, making it applicable for formal decision documentation across individual software projects.