skills.rest
jomcgi
jomcgiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

adr

Create and manage Architecture Decision Records with status tracking.

5|Updated Aug 26, 2024
Search Tags:#architecture#documentation#decisions#adr#governance#software-engineering
One-click install
npx skills add https://github.com/jomcgi/homelab --skill adr-jomcgi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/jomcgi/homelab/tree/main/.claude/skills/adr
Command: npx skills add https://github.com/jomcgi/homelab --skill adr-jomcgi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture decision records (ADRs) provide a durable, auditable trail of why and how architectural choices were made, keeping rationale accessible as decisions evolve.

Core Features & Use Cases

  • Scaffold ADRs: Create new ADR files under architecture/decisions/<category>/ with standardized templates.
  • Track decisions: Maintain status (Draft, Accepted, Implemented, Superseded, Deprecated) and references.
  • Lifecycle governance: Supersede obsolete ADRs and preserve history for traceability.

Quick Start

Create a new ADR with /adr create <category> <slug> to document the decision.

Frequently Asked Questions about adr

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

FAQPage Schema
What are architecture decision records and when do I need them in my software project?▼

Architecture decision records (ADRs) provide a durable, auditable trail capturing why and how architectural choices were made. You need them in software projects requiring an auditable decision history to keep rationale accessible as decisions evolve.

How do I create a new architecture decision record with a standardized template?▼

To create a new architecture decision record, use the command /adr create <category> <slug>. This scaffolds a new ADR file under architecture/decisions/<category>/ using a standardized template to document the decision.

How do I supersede an outdated architectural decision and preserve the history?▼

To supersede an outdated architectural decision, the Skill manages lifecycle governance by updating the ADR status to Superseded and creating references to the new decision. This preserves the original ADR history for traceability.

What statuses can I track for architecture decision records throughout their lifecycle?▼

You can track architecture decision records through five statuses: Draft, Accepted, Implemented, Superseded, and Deprecated. This lifecycle governance ensures decisions remain auditable as project requirements change.

What file structure and commit conventions should I use for managing ADRs?▼

ADRs should be located under architecture/decisions/<category>/ using numbered naming conventions. Commits managing these architecture decision records should use the adr: prefix to maintain a clear and auditable decision history.

Related Skills

Explore More Software Engineering Skills→
VitaDynamicsVitaDynamics

adr

Create sequentially numbered Architecture Decision Records in docs/adr/.

Official
Intermediate
DavidROliverBADavidROliverBA
49

ADR Report Skill

Generate markdown reports of ADR activity categorized by status and project.

Community
Intermediate
SantiagoisperSantiagoisper

lfg

Automate the full engineering pipeline from planning to CI loop.

Community
Advanced
simonheimlichersimonheimlicher
1

architecting-typescript

Create Architecture Decision Records for TypeScript architecture decisions.

Community
Advanced