An Architecture Decision Record (ADR) is a short text file that captures a significant architectural decision, including its context, the options considered, and the resulting consequences.

Where does this skill save the records?

It automatically creates and organizes records in the docs/decisions/ directory of your project using a 4-digit zero-padded naming convention (e.g., 0001-use-postgresql.md).

When should I write an ADR instead of a regular comment?

Use an ADR when a decision requires consulting multiple people, introduces new technology, conflicts with existing principles, or affects more than one team's autonomy.

What is a Y-statement?

A Y-statement is a structured sentence used as a forcing function to clarify the context, decision, and tradeoffs before writing the full ADR to ensure the logic is sound.

Architecture Decision Records (ADR)

Name: Architecture Decision Records (ADR)
Author: agentpatterns

byagentpatterns

•

学习与文档

Standardizes the creation of lightweight Architecture Decision Records to document technical choices, context, and tradeoffs within a project.

The ADR skill streamlines the process of capturing critical architectural decisions by providing a structured framework and rigorous decision filter based on Harmel-Law signals. It guides developers through a proven workflow—from initial decision filtering and 'Y-statement' clarification to generating immutable, version-controlled records in a standardized directory. By focusing on context, alternatives, and consequences rather than just implementation details, this skill ensures long-term project clarity and helps teams maintain a clear history of why specific technical paths were chosen.

主要功能

01Integrated decision filter to identify architecturally significant choices

024 GitHub stars

03Automated file naming and directory management for consistent record-keeping

04Support for decision lifecycle management including proposed, accepted, and superseded states

05Standardized ADR template focusing on context, consequences, and advice

06Y-statement forcing function to clarify logic before drafting

使用场景

01Documenting the adoption of a new technology or framework

02Capturing the rationale behind non-obvious technical tradeoffs during a transition

03Establishing a historical record of architectural shifts to aid in developer onboarding

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add agentpatterns/craft adr

For use in Claude.ai and ChatGPT

Download Skill