create-adr

Creates numbered Architecture Decision Records in MADR-lite format under docs/ADR/.

Updated Sep 3, 2024
One-click install
npx skills add https://github.com/eminboydak/duckTerm --skill create-adr-eminboydak
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-adr
Source: https://github.com/eminboydak/duckTerm/tree/main/.opencode/skills/create-adr
Command: npx skills add https://github.com/eminboydak/duckTerm --skill create-adr-eminboydak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping architecture decisions documented consistently is hard: numbering drifts, formats vary, and index files go stale. This Skill standardizes the creation of Architecture Decision Records so every decision follows the same DT-XXXX numbering, MADR-lite structure, and English prose conventions. ## Core Features & Use Cases - Sequential ADR numbering: Reads docs/ADR/INDEX.md to determine the next available DT-XXXX number with no gaps. - MADR-lite template: Generates Context, Decision, Consequences, and References sections with status fields (Proposed, Accepted, Deprecated, Superseded). - Index maintenance: Updates the ADR ledger table in docs/ADR/INDEX.md and produces a conventional commit message. - Use Case: After deciding to adopt a new state management approach in a Tauri/Svelte app, ask the assistant to record the decision; it creates docs/ADR/DT-0007-adopt-x-state-management.md and updates the index. ## Quick Start Ask the assistant to create an ADR documenting your latest architecture decision, for example by saying: create an ADR for adopting tauri-plugin-serialport for serial communication.

Frequently Asked Questions about create-adr

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

FAQPage Schema
How do I create an Architecture Decision Record?

Check docs/ADR/INDEX.md for the next available DT-XXXX number, then create a kebab-case Markdown file using the MADR-lite format with Context, Decision, Consequences, and References sections. Finally, add a row to the index ledger and commit with a docs(adr) message.

What format does an ADR follow in this workflow?

ADRs use a MADR-lite structure: a DT-XXXX numbered title, metadata fields for Date, Status, and Domain, followed by Context, Decision, Consequences, and References sections. All content is written in English.

Can I delete or renumber an old ADR?

No. Historical ADRs are never deleted and numbering is sequential with no gaps. Outdated records are marked as Deprecated or Superseded by another DT-XXXX record instead of being removed.

What status values can an ADR have?

An ADR status can be Proposed, Accepted, Deprecated, or Superseded by DT-XXXX. The status is set in the metadata block at the top of the record and updated as the decision lifecycle evolves.

When should I not use this ADR process?

Skip the ADR process for trivial implementation details, temporary experiments, or changes easily reversed without architectural impact. ADRs are meant for decisions with lasting consequences and trade-offs worth recording.