adr-workflow

Automate Architectural Decision Records lifecycle with atomic frontmatter mutations.

5|Updated May 12, 2026
One-click install
npx skills add https://github.com/ramboz/jig --skill adr-workflow-ramboz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-workflow
Source: https://github.com/ramboz/jig/tree/main/skills/adr-workflow
Command: npx skills add https://github.com/ramboz/jig --skill adr-workflow-ramboz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scaffolds, tracks, and enforces Architectural Decision Records (ADRs) lifecycle, from creation to acceptance and indexing, so decisions stay auditable.

Core Features & Use Cases

  • Scaffold new ADRs with automatic numbering and templates.
  • Manage ADR status transitions (Proposed -> Accepted, Superseded) and maintain an index.
  • Regenerate index docs and resolve refinement-todo entries with ADRs.

Quick Start

Run adr.py new to scaffold a new ADR, then use adr.py accept, index, and resolve-todo as needed.

Frequently Asked Questions about adr-workflow

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

FAQPage Schema
How do I automate Architectural Decision Records lifecycle management in git?

Automating the Architectural Decision Records lifecycle involves scaffolding new records, managing status transitions, and maintaining an index. This workflow enforces immutability of accepted records and uses atomic frontmatter mutations for auditability.

What is the best way to track ADR status transitions and keep an updated index?

Tracking ADR status transitions and maintaining an index is managed through dedicated automation commands. The workflow handles status shifts from Proposed to Accepted or Superseded and automatically regenerates index documentation to keep records synchronized.

How do I scaffold a new Architectural Decision Record with automatic numbering?

Scaffolding a new Architectural Decision Record with automatic numbering is done by running the creation command. This initializes the record using standardized templates and assigns the next sequential identifier automatically.

Can I enforce immutability of accepted ADRs in my documentation workflow?

Enforcing immutability of accepted ADRs is a core constraint of this workflow. Once a decision record reaches the Accepted state, the system prevents direct modification, requiring any changes to be made by superseding the original record.

How do I resolve refinement-todo entries using Architectural Decision Records?

Resolving refinement-todo entries is handled by linking them directly to accepted Architectural Decision Records. The workflow provides a specific command to map these pending todos to their corresponding resolution records for tracking.

Why use atomic frontmatter mutations for ADR auditability?

Atomic frontmatter mutations ensure ADR auditability by applying status changes as single, indivisible operations. This prevents partial updates to the document metadata, guaranteeing that the state tracked in git remains consistent and verifiable.