How do I create a new ADR with this skill?

You can use the built-in command '/create-adr [number] [title]' to automatically generate a formatted ADR template with pre-filled metadata like date and author.

Can I edit an ADR once it has been accepted?

Standard practice is to keep ADRs immutable. If a decision changes, you should create a new ADR that explicitly supersedes the old one to maintain a clear historical record.

Does this skill support the Nygard template?

Yes, it specifically follows the Nygard format, which includes sections for Title, Status, Context, Decision, Consequences, and Alternatives Considered.

What is an Architecture Decision Record (ADR)?

An ADR is a lightweight document that captures a significant architectural decision, the context in which it was made, and the consequences it has for the project's future.

Why should I store ADRs in Git instead of a Wiki?

Storing ADRs in version control ensures they live alongside the code they describe, making them easily accessible during code reviews and searchable within the developer workflow.

Architecture Decision Records (ADR)

Name: Architecture Decision Records (ADR)
Author: yonatangross

byyonatangross

•

学習とドキュメンテーション

Documents significant architectural decisions using standardized Nygard templates to preserve technical context and trade-offs.

The Architecture Decision Record (ADR) skill empowers developers and architects to capture the 'why' behind system design choices directly within their codebase. By utilizing the proven Nygard format, it ensures that every major decision—from database selection to framework adoption—includes essential context, considered alternatives, and long-term consequences. This skill streamlines the creation of immutable records, facilitating better team alignment, faster onboarding for new engineers, and a clear evolutionary history of the system's architecture without the need for external documentation tools.

主な機能

01Automated ADR generation with sequential numbering and metadata via integrated scripts

02Best practices guidance for maintaining immutable, version-controlled architecture logs

03Comprehensive trade-off analysis to document rejected alternatives and decision rationale

04Standardized Nygard ADR templates including context, decision, and consequences

05Lifecycle management for tracking decisions from proposed to superseded status

0669 GitHub stars

ユースケース

01Evaluating and selecting a specific database or cloud provider based on technical constraints

02Choosing between microservices and monolith architectures for a new project

03Establishing team-wide coding conventions or architectural patterns for long-term maintenance

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add yonatangross/orchestkit architecture-decision-record

For use in Claude.ai and ChatGPT

Download Skill