agentleFS
govctl-orggovctl-org/govctl/.claude/skills/adr-writer/SKILL.md

adr-writer

Skill276 starsChanged 38 days agoMITView on GitHub

Write decision records that explain context, evaluated alternatives, chosen direction, and consequences without creating product obligations

12 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 7 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read related decisions and requirements first with govctl adr show <ADR-ID> and govctl search <topic>.

    line 16
  2. Very specific:

    Do not accept, reject, or supersede an ADR here.

    line 22
  3. Distinctive:

    Stop if the governing requirement or the decision itself is unclear.

    line 27
  4. Very specific:

    Do not write Context, Decision, Consequences, or Alternatives Considered headings into content fields, and do not restate alternatives' …

    line 79
  5. Distinctive:

    every alternative was really considered, and an uncontested decision says so.

    line 85

“Common” is measured: kept by at least 6 in 10 of the 7 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

ADR Writer

Record why one design direction was chosen over alternatives, under what constraints, and with what consequences. An ADR is not a mini-RFC or an execution log.

Discovery

Read related decisions and requirements first with govctl adr show <ADR-ID> and govctl search <topic>; add --history only when superseded history matters. Use govctl <resource> --help for current syntax.

Hard Stops

  • Do not accept, reject, or supersede an ADR here; hand that to spec or gov.
  • RFCs own obligations, ADRs own design rationale, and Work Items own execution scope. Do not create behavior, validation, lifecycle, storage, or compatibility obligations in ADR prose, and do not record task scope, progress, commands, or validation output.
  • Stop if the governing requirement or the decision itself is unclear.

Writing Order

  1. Context: the problem, constraints, and decision drivers.
  2. Alternatives actually considered, with only the pros and cons that influenced the outcome. Never pad to a quota: one real rejected option beats three fabricated ones, and when only one viable direction exists, say so in a sentence.
  3. Mark chosen and rejected alternatives and why each rejected one lost.
  4. Decision: commit clearly to what is decided, as the conclusion of that comparison.
  5. Consequences: benefits, costs, and mitigations, not only benefits.

For a historical backfill, separate recovered evidence from inference and say so when alternatives cannot be recovered.

Decide Only What Must Be Decided Now

An ADR written before implementation has little evidence about low-level design, yet implementing agents treat everything it states as settled. Record the direction, boundaries, and constraints that are costly to reverse or that other work depends on. For each sub-choice, ask whether deciding it during coding would lose anything; if not, leave it out, or name it as deferred to implementation with any constraint it must respect.

Data layouts, helper decomposition, algorithms, error-handling mechanics, and step-by-step procedures rarely belong in an ADR written before code exists. Record such a choice after implementation has produced the evidence. Language-specific structure belongs only when it is central to the decision.

Keep It Short

A typical ADR is a few dozen lines. Cut background the reader already has, alternatives nobody seriously considered, and pros and cons that did not matter. Bloat is a defect: it hides the decision.

Normative keywords quoted from an RFC do not make the ADR authoritative. Rewrite accidental obligation lists as rationale, or move the missing contract to its RFC.

Projection Ownership

Per [[RFC-0000:C-ADR-PROJECTION-OWNERSHIP]]:

ContentOwner
Metadata and fixed section headingsRenderer
Reference inventoryrefs
Options, statuses, pros/cons, rejection reasonscontent.alternatives
Explanatory prosecontext, decision, consequences

Do not write Context, Decision, Consequences, or Alternatives Considered headings into content fields, and do not restate alternatives' statuses, pros, cons, or rejection reasons in prose.

Before Handoff

  • every alternative was really considered, and an uncontested decision says so;
  • the decision leaves choices that coding can settle better to implementation;
  • consequences include real costs;
  • references connect the decision to its governing RFCs, and configured project tags are applied;
  • govctl check passes; and
  • adr-reviewer has no unresolved critical finding.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.