adr

Record architectural decisions with context, decision, and consequences in docs/adr.

3.4k|728|Updated Jun 28, 2022
One-click install
npx skills add https://github.com/linuxfoundation/crowd.dev --skill adr-linuxfoundation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/linuxfoundation/crowd.dev/tree/main/.claude/skills/adr
Command: npx skills add https://github.com/linuxfoundation/crowd.dev --skill adr-linuxfoundation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architectural decisions are often made quickly and without a single source of truth. ADRs provide a lightweight, auditable record of the reasoning behind technology choices, patterns, and deployment strategies so future maintainers can understand why decisions were made.

Core Features & Use Cases

  • ADR template enforcement: Ensure every decision is documented with context, decision, and consequences.
  • Traceability & retrieval: Store ADRs under docs/adr/ and enable querying why a decision was made.
  • Guided workflow: Step-by-step process for creating, reviewing, and updating ADRs.

Quick Start

Create a new ADR file in docs/adr/ describing the decision and its rationale using the ADR template.

Frequently Asked Questions about adr

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

FAQPage Schema
What is an architectural decision record and when should I create one?

An architectural decision record (ADR) captures the rationale behind technology choices, patterns, and deployment strategies. You should create an ADR when selecting frameworks, libraries, or deployment approaches to provide an auditable record for future maintainers.

How do I document architectural decisions and their rationale?

You document architectural decisions by creating an ADR file under the docs/adr directory. The process enforces a standard template to ensure every record captures the context, decision, alternatives, and consequences for future reference.

What is the best way to keep track of engineering decisions and alternatives?

The best way to track engineering decisions is using ADRs stored under docs/adr/. This provides a single source of truth and a guided, step-by-step workflow for creating, reviewing, and updating the rationale behind selected alternatives.

Does this ADR workflow require any specific dependencies or components?

This ADR workflow requires no external dependencies or components. It operates independently to enforce the ADR template, store files under docs/adr, and provide a documented workflow for creating and reviewing decisions.

Can I use architectural decision records for documenting deployment approaches?

Yes, you can use architectural decision records for documenting deployment approaches. ADRs are applicable whenever you select patterns or deployment strategies, ensuring you document alternatives and rationale for future reference.

Why does my team need a standard template for architectural decisions?

Your team needs a standard template for architectural decisions to ensure every record includes context, the decision, and consequences. This prevents omitting critical rationale and maintains a consistent, auditable history of engineering choices.