What is an Architecture Decision Record (ADR)?

An ADR is a document that captures an important architectural decision made along with its context and consequences. It serves as a permanent record of why a specific path was chosen.

What formats does this skill support?

It supports multiple industry-standard formats including MADR (Markdown Architecture Decision Records), lightweight formats for smaller teams, and Y-Statements for concise decision summaries.

When should I write an ADR instead of just code comments?

Write an ADR for significant choices like framework adoption, database selection, or security architecture. Use code comments for implementation details, but use ADRs for the high-level 'why' that affects the whole project.

How do ADRs help with team onboarding?

They provide a 'paper trail' for new developers, allowing them to understand the reasoning behind existing infrastructure without having to ask veteran team members about decisions made years ago.

Can I use this for proposing new changes?

Yes, the skill includes RFC-style templates specifically designed for proposing architectural changes and gathering team feedback before a decision is finalized.

Architecture Decision Records (ADR)

Name: Architecture Decision Records (ADR)
Author: duanbiao2000

byduanbiao2000

0•

학습 및 문서화

Document and maintain significant technical decisions using standardized Architecture Decision Record patterns and lifecycle management.

This skill provides comprehensive templates and best practices for creating, maintaining, and managing Architecture Decision Records (ADRs) within your project. It empowers engineering teams to capture the 'why' behind critical technical choices—including the problem context, considered alternatives, trade-offs, and long-term consequences—ensuring that architectural knowledge remains accessible and searchable. By implementing standardized formats like MADR and Y-Statements, this skill helps teams avoid 'tribal knowledge' pitfalls, streamlines the onboarding of new developers, and provides a clear audit trail for the evolution of a system's architecture.

주요 기능

01Comprehensive lifecycle management (Proposed, Accepted, Deprecated, Superseded)

020 GitHub stars

03Guidance for documenting technical trade-offs and decision drivers

04Structured directory patterns for managing long-term architectural history

05Standardized ADR templates including MADR, Lightweight, and Y-Statement formats

06Integrated RFC (Request for Comments) style templates for complex proposals

사용 사례

01Onboarding new team members by providing a historical context of architectural evolution

02Managing the deprecation of legacy technologies and the transition to new systems

03Documenting the rationale for choosing specific databases, frameworks, or API patterns

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add duanbiao2000/obsidiandoc26 architecture-decision-records

For use in Claude.ai and ChatGPT

Download Skill