adr-suggest

Suggest documenting architectural decisions at key decision points.

Updated Feb 28, 2019
One-click install
npx skills add https://github.com/rjschie/dotfiles --skill adr-suggest
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr-suggest
Source: https://github.com/rjschie/dotfiles/tree/main/files/claude/skills/adr-suggest
Command: npx skills add https://github.com/rjschie/dotfiles --skill adr-suggest

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users capture architectural decisions (ADRs) by suggesting documentation at key decision-making moments, ensuring important decisions are not overlooked.

Core Features & Use Cases

  • Decision Detection: Identifies ADR-worthy decisions based on criteria like reversibility, context, and trade-offs.
  • User Nudges: Suggests running /adr <slug> to document decisions, enhancing decision-making practices.
  • Use Case: After a heated discussion about a new feature, the Skill suggests documenting the decision to standardize on a specific approach.

Quick Start

Use the adr-suggest skill during a planning session to capture architectural decisions.

Frequently Asked Questions about adr-suggest

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

FAQPage Schema
How do I know when to document an architectural decision?▼

You should document an architectural decision when it involves significant trade-offs, specific context, or low reversibility. Identifying these key decision points ensures important architectural choices are captured and not overlooked during planning sessions.

How do I capture architectural decisions during a planning session?▼

To capture architectural decisions during a planning session, run the `/adr <slug>` command when prompted by a suggestion. This user input triggers the documentation process, allowing you to record the trade-offs and context of the decision.

What is an architectural decision record and why is it needed?▼

An architectural decision record (ADR) documents important technical choices, their context, and consequences. It is needed to ensure significant decisions are not overlooked, providing a clear history of why specific approaches were standardized over alternatives.

Can I automatically document decisions without manual input?▼

No, documenting decisions requires user input. The mechanism suggests documenting architectural decisions at key moments, but you must explicitly run the `/adr <slug>` command to capture the context, trade-offs, and details.

What is the best way to track reversible versus irreversible architectural decisions?▼

The best way to track these architectural decisions is to evaluate their reversibility and trade-offs during discussions, prompting the user to document them via an ADR. This ensures both reversible and irreversible choices are captured systematically.