adr-writer

Evaluate architecture decisions and generate ADR records in Nygard format.

Updated May 17, 2022
One-click install
npx skills add https://github.com/kanade0404/dotfiles --skill adr-writer-kanade0404
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adr-writer
Source: https://github.com/kanade0404/dotfiles/tree/main/.opencode/skills/adr-writer
Command: npx skills add https://github.com/kanade0404/dotfiles --skill adr-writer-kanade0404

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you decide whether a design choice is important enough to preserve as an ADR, so you do not clutter the history with trivial implementation details.

Core Features & Use Cases

  • ADR Worthiness Check: Filters out decisions that can be understood directly from code and keeps only choices that are hard to reverse or likely to be questioned later.
  • Structured ADR Creation: Drafts Michael Nygard style ADRs with clear Context, Decision, Consequences, and Alternatives Considered sections.
  • Decision Governance: Supports design reviews, architecture changes, technology selection, and superseding older decisions while preserving history.
  • Use Case: When a team debates a database migration, this Skill determines whether the decision should be recorded as an ADR and then prepares the record in the right format.

Quick Start

Ask the adr-writer skill to judge whether this change deserves an ADR and, if it does, draft the record in Nygard format.

Frequently Asked Questions about adr-writer

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

FAQPage Schema
How do I know if an architecture decision needs an ADR?

An architecture decision needs an ADR if it is hard to reverse or likely to be questioned later. ADR worthiness checks filter out trivial implementation details that can be understood directly from code, keeping only enduring design choices.

What is the best way to document a technology adoption decision?

The best way to document technology adoption is using a structured ADR. This approach drafts records with Context, Decision, Consequences, and Alternatives Considered sections to preserve the reasoning behind the choice.

How do I write an ADR using adr-tools conventions?

To write an ADR using adr-tools conventions, draft a Michael Nygard style record. This format enforces structured sections for Context, Decision, Consequences, and Alternatives without writing usage docs.

When should I not use an architecture decision record?

You should not use an architecture decision record for trivial implementation details that can be understood directly from code. ADRs are reserved for choices that are hard to reverse or likely to be questioned later.

Can I use an ADR to supersede older architecture decisions?

Yes, you can use an ADR to supersede older architecture decisions. This decision governance process supports technology changes and breaking changes while preserving the history of previous design choices.

How does an ADR worthiness check work for design reviews?

An ADR worthiness check for design reviews evaluates whether a design choice is important enough to preserve. It filters out decisions understandable from code, keeping only choices that are hard to reverse or likely questioned later.