adr-author

Drafts numbered ADRs and updates the index with cross-links and eligibility checks.

18|Updated Feb 14, 2020
One-click install
npx skills add https://github.com/subroh0508/colormaster --skill adr-author-subroh0508
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-author
Source: https://github.com/subroh0508/colormaster/tree/main/.claude/skills/adr-author
Command: npx skills add https://github.com/subroh0508/colormaster --skill adr-author-subroh0508

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill turns architecture decisions into well-structured ADRs, helping teams record important choices only when they meet the project’s writing criteria and keep decision history easy to trace.

Core Features & Use Cases

  • ADR Eligibility Check: Evaluates whether a decision should become an ADR or be recorded in a lighter-weight document instead.
  • ADR Drafting and Numbering: Creates a new ADR with the next available ID, fills the template, and writes the decision narrative in a consistent format.
  • Cross-Reference Management: Adds related ADR links, supersedes relationships, and updates the ADR index for discoverability.
  • Use Case: A team chooses a new architecture for a feature and wants a concise ADR draft with linked predecessors, clear rationale, and an updated catalog entry.

Quick Start

Ask the skill to draft an ADR for your decision, including the context, preferred option, and any related ADRs that should be linked or superseded.

Frequently Asked Questions about adr-author

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

FAQPage Schema
How do I draft an architecture decision record with linked predecessors and an updated index?

To draft an architecture decision record, the skill applies sequential numbering, fills a standardized template with your decision narrative, and updates the ADR index. It manages bidirectional links to connect related records and superseded relationships automatically.

When does a technical decision meet the threshold for an ADR entry?

A technical decision meets the threshold for an ADR entry after passing an eligibility validation check. The skill evaluates whether a choice requires a formal architecture decision record or if a lighter-weight document is more appropriate for logging the decision.

What's the best way to maintain ADR traceability and cross-link related records in a software repository?

The best way to maintain ADR traceability is through bidirectional link management and structured documentation updates. The skill handles cross-reference management by adding related ADR links and superseded relationships, keeping decision history easy to trace in the repository.

How do I manage ADR numbering and catalog entries for new architecture decisions?

You manage ADR numbering by assigning the next available ID to each new architecture decision record. The skill automates this sequential numbering process while simultaneously updating the ADR catalog entry to ensure discoverability.

Do I need to manually update the ADR index after creating a new decision record?

You do not need to manually update the ADR index after creating a new decision record. The skill automatically maintains the index through structured documentation updates, ensuring new entries are cataloged for discoverability.