skills.rest
app-sre
app-sreOFFICIAL
Explore all skills by this author →
GitHub

adr

Create and manage Architecture Decision Records with frontmatter metadata and README index.

37|106|Updated Nov 15, 2018
Search Tags:#templates#documentation#adr#governance#design-patterns#software-architecture#architecture-decision
One-click install
npx skills add https://github.com/app-sre/qontract-reconcile --skill adr-app-sre
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/app-sre/qontract-reconcile/tree/main/.claude/skills/adr
Command: npx skills add https://github.com/app-sre/qontract-reconcile --skill adr-app-sre

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Architecture Decision Records (ADRs) provide a standardized way to capture, discuss, and archive architectural decisions so teams align on the rationale behind design choices over time.

Core Features & Use Cases

  • Template-driven creation: Use a consistent ADR template and location (docs/adr) for all decisions.
  • Lifecycle and governance: Propose, review, and update ADRs with status, authorship, and date metadata.
  • Team-wide discoverability: Centralized README index lists all ADRs and their categories for quick discovery.

Quick Start

Create a new ADR by following the ADR-000-template.md in docs/adr and save it under docs/adr.

Frequently Asked Questions about adr

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

FAQPage Schema
What is an Architecture Decision Record and when do I need one for my software project?▼

An Architecture Decision Record (ADR) captures the rationale behind design choices to align teams on architectural decisions. You need ADRs when software projects require a standardized lifecycle to propose, discuss, and archive structural changes over time.

How do I create and manage Architecture Decision Records automatically?▼

You create Architecture Decision Records by applying a standardized template structure within the docs/adr directory. The process automates ADR lifecycle management by generating frontmatter metadata for authorship and status, while maintaining a centralized README index for team-wide discovery.

Does the ADR template process support governance and lifecycle tracking across teams?▼

The ADR process supports team-wide governance by tracking the lifecycle of architectural decisions. It embeds frontmatter metadata for status, authorship, and date, allowing teams to consistently propose, review, and update design choices from proposal to revision.

What is the best way to organize and discover Architecture Decision Records in a repository?▼

The best way to organize Architecture Decision Records is to save them in a dedicated docs/adr location using a consistent template. This approach maintains a centralized README index that lists all ADRs and their categories for quick team-wide discovery.

Do I need any specific dependencies or components to start documenting software architecture decisions?▼

You do not need any specific dependencies or components to document software architecture decisions. The process relies on standard markdown templates and frontmatter metadata, requiring only a repository to store the docs/adr directory and maintain the README index.

Related Skills

Explore More Software Engineering Skills→
xxihxxih
1

architecture-decision-records

Capture architecture decisions as structured ADR documents in docs/adr.

Community
Intermediate
xloxn69xloxn69
7

agileflow-adr

Convert discussed architectural decisions into MADR-formatted ADR files.

Community
Basic
alunduilalunduil
1

adr

Detect existing ADRs and scaffold new ones with correct numbering and structure.

Community
Intermediate
haxlyshaxlys

architecture-decision-records

Manage Architecture Decision Records with structured templates and lifecycle guidance.

Community
Advanced