skills.rest
theodrosyimer
theodrosyimerCOMMUNITY
Explore all skills by this author →
GitHub

adr

Create, query, and supersede ADR files under docs/adr/ with sequential naming.

1|Updated Jan 13, 2023
Search Tags:#architecture#adr#design-decisions#decision-log#doc-as-code#architecture-decision-record#adr-management
One-click install
npx skills add https://github.com/theodrosyimer/.dotfiles --skill adr-theodrosyimer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/theodrosyimer/.dotfiles/tree/main/claude/skills/arch__adr
Command: npx skills add https://github.com/theodrosyimer/.dotfiles --skill adr-theodrosyimer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Architectural decisions and trade-offs are often discussed informally and lost in PRs, issue threads, or personal notes; this Skill provides a consistent, discoverable record so teams can understand what decisions were made, why, and when to revisit them. It prevents ad-hoc changes from drifting the architecture and makes rationale available for future contributors and code reviews.

Core Features & Use Cases

  • Create ADRs: Fill the project's ADR template and save a sequentially numbered file under docs/adr with a clear title, status, confidence, context, decision, consequences, and alternatives.
  • Query & Summarize: Search existing ADRs or summarize the current architectural stance before implementing or reviewing code.
  • Supersede & Maintain: Guide the workflow for creating superseding ADRs, updating statuses immutably, and regenerating the ADR index to keep the decision log accurate.
  • Standards & Quality Checks: Enforce naming conventions, template completeness, diagram standards (structured text diagrams), and the ADR quality checklist before finalization.
  • Seed & Bootstrap: Assist bootstrapping ADRs from seed files and guide initial review and contextualization for a new project.

Quick Start

Create a new ADR titled Use Modular Monolith as Default Architecture using the ADR template and save it to docs/adr/0002-use-modular-monolith-as-default-architecture.md.

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 should I create one?▼

An architecture decision record (ADR) captures architectural choices, rationale, and consequences for project-level trade-offs. You should create one during code reviews, feature design discussions, or PR debates when an architectural choice must be formally recorded.

How do I create a new architecture decision record and save it to my project?▼

To create an architecture decision record, fill the project's ADR template with title, status, context, decision, consequences, and alternatives, then save it as a sequentially numbered, zero-padded file under docs/adr/.

How do I supersede an old architecture decision record without losing the original context?▼

To supersede an architecture decision record, create a new ADR that references the old one, update the original record's status immutably to superseded, and regenerate the ADR index to keep the decision log accurate.

Can I search existing architecture decision records before implementing a new feature?▼

Yes, you can query and summarize existing architecture decision records to understand the current architectural stance before implementing or reviewing code, ensuring new features align with previously established project trade-offs.

What quality checks are enforced when finalizing an architecture decision record?▼

Quality checks for an architecture decision record enforce naming conventions, template completeness, structured text diagram standards, and the ADR quality checklist before finalization to ensure the decision log remains consistent and discoverable.

Related Skills

Explore More Software Engineering Skills→
aifuunaifuun

manage-adr

Create, list, show, and validate ADR files with TL;DR format and YAML metadata.

Community
Advanced
wesleyegbertowesleyegberto
3

architecture-decision-records

Document architectural decisions as structured ADR files under docs/adr.

Community
Advanced
shaitamam-80shaitamam-80

manuscript-writer

Assemble systematic review outputs into PRISMA 2020-compliant manuscript sections.

Community
Advanced
CygnusfearCygnusfear
5

the-archivist

Document engineering decisions as ADRs with rationale and decision logs.

Community
Advanced