adr

Manage Architecture Decision Records across their lifecycle with MADR workflows.

3|1|Updated Feb 3, 2012
One-click install
npx skills add https://github.com/shishi/dotfiles --skill adr-shishi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/shishi/dotfiles/tree/main/claude/skills/adr
Command: npx skills add https://github.com/shishi/dotfiles --skill adr-shishi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manage Architecture Decision Records (ADRs) across their lifecycle.

Core Features & Use Cases

  • ADR lifecycle management: read existing ADRs, draft new ADRs, update statuses (proposed -> accepted -> deprecated), or supersede outdated decisions.
  • ADR alignment in development workflows: reference ADRs in commits to ensure architectural decisions guide feature work and refactors.
  • Templates and discovery: rely on MADR template.md, operations.md, and queries.md to locate, organize, and reason about ADRs.

Quick Start

Draft an ADR for the upcoming architectural decision following the template.md, then commit with a message that references the ADR.

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 when should I document one?

An Architecture Decision Record (ADR) captures architectural choices and their context. You should document one whenever a structural decision impacts feature work or refactors, ensuring architecture stays aligned with current development.

How do I draft and manage ADRs using the MADR template?

To draft and manage ADRs, apply the MADR template.md to structure your decision record. You can then read, update its status from proposed to accepted, or deprecate it, while using operations.md and queries.md to organize and locate records.

How do I reference architecture decision records in my git commit history?

You reference architecture decision records in git commits by including the ADR identifier in your commit messages. This enforces a workflow where architectural decisions explicitly guide and align with the committed feature work and refactors.

Can I supersede outdated architecture decisions instead of deleting them?

Yes, you can supersede outdated architecture decisions rather than deleting them. The ADR lifecycle management supports moving decisions to a deprecated status and linking them to the new accepted records to preserve historical context.

Does this ADR workflow enforce specific file naming conventions?

Yes, the ADR workflow enforces specific naming conventions for decision records. By leveraging the MADR template.md alongside operations.md and queries.md, it standardizes file naming to ensure ADRs are easily located and organized.