adr

Create and update Architecture Decision Records using MADR templates.

6|Updated Dec 28, 2023
One-click install
npx skills add https://github.com/staticWagomU/dotfiles --skill adr-staticwagomu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/staticWagomU/dotfiles/tree/main/config/claude/skills/adr
Command: npx skills add https://github.com/staticWagomU/dotfiles --skill adr-staticwagomu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture Decision Records (ADRs) provide a lightweight governance framework to capture why architectural choices were made, ensure traceability, and guide future development amid changing requirements.

Core Features & Use Cases

  • Read existing ADRs to understand current decisions and statuses across the project.
  • Write new ADRs using the MADR template and align development work with documented decisions.
  • Update ADR statuses (proposed, accepted, deprecated, superseded) and supersede or deprecate when needed to reflect changes in direction.

Quick Start

Draft or update an ADR using the MADR template to capture the decision, rationale, and consequences.

Frequently Asked Questions about adr

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

FAQPage Schema
How do I document architectural decisions using MADR templates?

You can document architectural decisions by drafting new Architecture Decision Records using the enforced MADR template to capture the decision context, rationale, and consequences for your project.

What is the best way to manage Architecture Decision Records throughout their lifecycle?

Managing Architecture Decision Records involves reading existing records, writing new ones, and updating statuses like proposed, accepted, deprecated, or superseded to keep architecture choices aligned with development.

How do I supersede or deprecate an accepted Architecture Decision Record?

You can supersede or deprecate an accepted Architecture Decision Record by updating its status to reflect changes in direction, ensuring the governance framework maintains accurate traceability for future development.

When do I need to create an Architecture Decision Record for my software project?

You need to create an Architecture Decision Record when making significant architectural choices, ensuring lightweight governance to capture why decisions were made and guide future development amid changing requirements.

Can I integrate Architecture Decision Records into my existing software workflow and commit practices?

Yes, you can integrate Architecture Decision Records into your software workflow through commit integration practices and discovery guidelines that embed ADR decisions directly into ongoing development processes.