mcpField
A
adr-skill

adr-skill

github.com/joelhooksDevelopment6650 installsUpdated 1d ago
Repository

About adr-skill

adr-skill guides agents and developers in recording and maintaining architecture decision records (ADRs). It covers decision research, drafting, review, status changes, and verification while preserving authorization boundaries and project conventions.

Key features

  1. 01Assess when an ADR is warranted
  2. 02Review existing records and code
  3. 03Document options and consequences
  4. 04Draft and validate records
  5. 05Manage lifecycle and cross-links

Use cases

  1. 01Recording a durable architecture choice
  2. 02Reviewing an ADR before changing governed code
  3. 03Updating status after authorized approval
  4. 04Checking implementation and validation before marking shipped

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/joelhooks/joelclaw --skill adr-skill

After installing, type/adr-skillin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
assets/
small-logo.svg
assets/templates/
adr-madr.md
adr-readme.md
adr-simple.md
references/
adr-conventions.md
examples.md
review-checklist.md
template-variants.md
scripts/
bootstrap_adr.js
new_adr.js
set_adr_status.js

Details

From the project README

Architecture decisions

Use an ADR for a durable architectural choice with meaningful alternatives or consequences. Routine fixes and established implementation choices need no new ADR. Consult relevant accepted records before changing their governed code.

Capture the decision

Read the project's instructions, existing decision index, relevant records, dependencies, and affected code. Reuse existing conventions. In a Brain tree, write prose as .svx.

Extract intent from the request and sources. Ask only for missing decisions that prevent an accurate record. A request to document a settled decision needs no preliminary interview or confirmation round. Keep an unapproved choice proposed; do not accept it merely because it ranked first in a queue.

Capture the trigger, constraints, considered alternatives, selected option, consequences, non-goals, and conditions for revisiting it. Distinguish the user's decision from the agent's recommendation.

Write and verify

Use template variants to choose the simple or MADR template in assets/templates/. Include affected paths, patterns, implementation steps, and observable validation where implementation is in scope. Name only skills actually needed for that work.

Read the review checklist after drafting. Fix factual and completeness gaps from sources. Ask about unresolved consequential choices, not ordinary editing. Add a diagram only when it clarifies architecture; verify any tool or slash command before invoking it.

Link the ADR to governed code and implementation receipts. A short code reference at the relevant boundary is enough. Update the existing index and visual links when applicable.

Done means the record accurately states the decision and status, sources, consequences, implementation boundary, and verification. Report unresolved gaps without inventing acceptance.

Lifecycle

For acceptance, rejection, deprecation, or supersession, use the user's authorization and the project's status conventions. Preserve history; superseding records link both ways. Mark shipped only after checking the implementation and recording its validation.

Tracker creation and implementation are separate actions unless included in the request. Selecting the next proposed ADR does not authorize its acceptance or execution.

For the existing JoelClaw ADR store, the sync event is system/adr.sync.requested with source adr-skill; verify the current owning handler before emission. Use the project's own indexing path elsewhere. A local draft does not justify an unrelated fleet-wide sync.

Tools and references

Read current help before use:

  • scripts/new_adr.js: create from a template and optionally update the index.
  • scripts/set_adr_status.js: update the record's status.
  • scripts/bootstrap_adr.js: initialize ADR conventions when requested.
  • ADR conventions: naming, status, and lifecycle.
  • Examples: completed records.

For a requested next-ADR search, inspect joelclaw vault adr --help. Rank candidates by readiness and value, then verify whether they already shipped.

Comments

Markdown supported