skills.rest
rjschie
rjschieCOMMUNITY
Explore all skills by this author →
GitHub

adr

Automate Architecture Decision Record creation, indexing, and repository updates.

Updated Feb 28, 2019
Search Tags:#architecture#code review#software development#adr#decision documentation
One-click install
npx skills add https://github.com/rjschie/dotfiles --skill adr-rjschie
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr
Source: https://github.com/rjschie/dotfiles/tree/main/files/claude/skills/adr
Command: npx skills add https://github.com/rjschie/dotfiles --skill adr-rjschie

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

The Skill simplifies the process of creating Architecture Decision Records (ADRs) by automating the interview process, drafting, and indexing of ADRs in a repository.

Core Features & Use Cases

  • Automated ADR Interview: Facilitates the capture of ADR context and user input through an interview process.
  • ADR Creation and Indexing: Automatically generates ADRs in the correct format and updates the repository index.
  • Use Case: When a technical decision needs to be documented, the user can initiate the process with a simple command, leading to a structured and accessible ADR.

Quick Start

Run the command: /adr <slug>

Frequently Asked Questions about adr

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

FAQPage Schema
How do I document architectural decisions for software development?▼

To document architectural decisions, you can use an Architecture Decision Record (ADR) to capture the context, decision, and consequences. This Skill automates the ADR creation process through a structured interview and repository indexing.

What is the best way to maintain an ADR repository?▼

Maintaining an ADR repository is best achieved by automating the creation and indexing of records. This Skill generates ADRs in a standardized format and automatically updates the repository index to ensure documentation remains accessible.

How does an automated ADR interview process work?▼

An automated ADR interview process works by prompting the user for context and technical decisions. This Skill uses that input to draft the Architecture Decision Record and integrate it directly into your documentation repository.

Do I need a structured repository to store Architecture Decision Records?▼

Yes, a structured repository is required to store Architecture Decision Records. The Skill relies on this organized environment to correctly save the generated ADRs and automatically update the repository's index.

When should I use Architecture Decision Records in software engineering?▼

Architecture Decision Records should be used in software engineering whenever a significant technical decision is made. The Skill helps document the context and consequences of these decisions to maintain a comprehensive architectural history.

Can I automate code review documentation for architectural choices?▼

Yes, you can automate documentation for architectural choices by using ADRs during the code review process. This Skill captures the technical decisions and their context, ensuring that architectural rationale is properly recorded.

Related Skills

Explore More Software Engineering Skills→
simonheimlichersimonheimlicher
1

architecting-typescript

Create Architecture Decision Records for TypeScript architecture decisions.

Community
Advanced
tsunami28tsunami28

governance-author-adr

Create MADR-style Architecture Decision Records following repository conventions.

Community
Advanced
javiarmestojaviarmesto

add-decision-record

Record architectural decisions as timestamped markdown files in project directories.

Community
Advanced
ProjAnvilProjAnvil
3

tech-documentation

Draft API and architecture documentation using standardized templates.

Official
Intermediate