agentleFS
willsu88willsu88/skills/writing-adrs/SKILL.md

writing-adrs

Skill2 starsChanged 4 months agoMITView on GitHub

Decide whether a decision deserves an ADR and write it in a form that survives re-litigation - use when a real trade-off was just settled, when asked "should this be an ADR?", or when recording an architectural decision.

3 other projects use a version of this.

Adopted by

Most recently taken up by

  • Other versions3 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 3

    1. dork-labs/dorkos★ 11same name
    2. mattwynne/skills★ 6same name
    3. Arcadi4/skills★ 4same name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository6 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 4 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 3 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    All three must hold (gate test after Matt Pocock's ADR format).

    line 16
  2. Distinctive:

    If the title cannot be written as an assertion, the decision is not actually settled yet.

    line 32
  3. Distinctive:

    Before drafting, read one or two existing ADRs in the repo and match their voice and density.

    line 36
  4. Distinctive:

    If a consequence names work that must happen before some future change, say so explicitly.

    line 52

“Common” is measured: kept by at least 6 in 10 of the 3 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

Writing ADRs

An ADR exists to stop a settled decision from being re-litigated and to let it be honestly re-evaluated when conditions change. Those two jobs dictate everything below: a conclusion alone can do neither; only the argument - alternatives, kill reasons, costs - can.

ADRs live in docs/adr/, numbered sequentially: 0001-slug.md. Scan for the highest existing number and increment.

Step 1: The gate - should this be an ADR at all?

All three must hold (gate test after Matt Pocock's ADR format); if any fails, stop and say so:

  1. Hard to reverse - changing your mind later has meaningful cost.
  2. Surprising without context - a future reader would look at the code and wonder why.
  3. A real trade-off - genuine alternatives existed and one was picked for specific reasons.

The gate keeps volume low; rigor below is affordable precisely because few decisions pass.

Step 2: Title as an assertion

The H1 states the decision as a full sentence a reader could disagree with - never a topic label.

  • Yes: "The deploy script is the test gate, not CI."
  • Yes: "Provider access goes through a hand-written LLMClient seam."
  • No: "Testing strategy." / "ADR 5: LLM client."

If the title cannot be written as an assertion, the decision is not actually settled yet.

Step 3: Context, concretely

Before drafting, read one or two existing ADRs in the repo and match their voice and density. Open with what is true in the system, using real file paths, function names, and numbers - not abstractions. State the forces that made the decision necessary. A reader should be able to verify every claim against the code.

Step 4: Considered options - mandatory, each rejection named with its kill reason

List every alternative seriously considered, each with the specific reason it lost - one sentence of judgment, not "didn't fit our needs." Mark the chosen option last.

A decision that passed the real-trade-off gate by definition has alternatives worth recording. The named rejection is what prevents the alternative from being proposed again in six months, and the kill reason is the premise to re-check when conditions change.

Step 5: Consequences - mandatory, honest about costs

Record what the decision buys and what it costs, including the permanent costs ("translation is maintained forever"), known limitations, and future obstacles the choice creates. If a consequence names work that must happen before some future change, say so explicitly.

Writing this section is a forcing function: if the costs cannot be written down, the decision is not finished being made. An ADR whose consequences section contains only upside is advocacy, not a record.

Step 6: Cross-reference

Cross-reference related ADRs by number ("the same judgment as the hand-rolled loop, ADR 0004") - decisions form a system, and the links are how a reader discovers it.

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.