agentleFS
emiliosheinzemiliosheinz/agent-skills/create-adr/SKILL.md

create-adr

Skill20 starsChanged 26 days agoMITView on GitHub

Writes an Architecture Decision Record (ADR) for a choice already made: its context, the decision, and the consequences. TRIGGER when: the user asks to create or write an ADR, document a decision, record why something was chosen, capture an architectural decision, or preserve the reasoning behind a finalized technical choice. SKIP for: decisions that have not been made yet (use `/create-rfc`), implementation planning or breaking work into tasks (use `/forge plan`), or general documentation that is not a decision record.

16 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-plan.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • JetBrainsSkill

    create-plan

    Research the codebase and create an implementation plan with architecture notes, design document, and track decomposition. Use when starting a new feature or large change.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 13 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Never invent facts: If a mandatory field is missing, ask.

    line 29
  2. Distinctive:

    Run the process in order. Read the matching reference file fully before acting — it is the playbook for that step.

    line 40
  3. Very specific:

    Run the quality checklist (references/quality.md) before finalizing — titles, honest trade-offs, options actually compared, naming …

    line 51
  4. Very specific:

    Never cover a gap with an invented answer.

    line 67

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

Create ADR

Produce one ADR per invocation. An ADR records a decision that has already been made; if the decision is still open, use /create-rfc. Follow the five-step process in order: Step 2 validates the mandatory fields, and drafting starts once every one of them is present.

Hard rules

  • Never invent facts. If a mandatory field is missing, ask. Never fill Context, Decision, or Consequences with plausible-sounding filler.
  • Never edit an existing ADR to change the decision. Supersede with a new ADR and link back. ADRs are historical records.
  • Never skip trade-offs. Consequences must be honest — include what becomes harder, not just what becomes easier.
  • Write in the user's language — the one they are using in this session, every section of the document included.

Dispatch

Run the process in order. Read the matching reference file fully before acting — it is the playbook for that step.

StepReadPurpose
1 — Gather contextreferences/process.mdAsk for decision, format, status, supersedes
2 — Validate mandatory fieldsreferences/process.mdEnsure title, date, status, context, decision, consequences are present
3 — Pick formatreferences/formats.mdMADR (default) / Nygard / Y-Statement
4 — Assign numberreferences/numbering.mdScan directory, assign next sequential number
5 — Generate + placereferences/process.md + one of templates/adr-{madr,nygard,y-statement}.mdFill template, run quality checklist, confirm file location

Run the quality checklist (references/quality.md) before finalizing — titles, honest trade-offs, options actually compared, naming convention.

Templates

Pure markdown scaffolds; load only the one for the chosen format:

FormatTemplate
MADR (default)templates/adr-madr.md
Nygardtemplates/adr-nygard.md
Y-Statementtemplates/adr-y-statement.md

Universal rules

  1. Honesty. Record trade-offs, unknowns, and open questions honestly. Never cover a gap with an invented answer. If a field cannot be filled, ask or leave an italicized placeholder (*to be confirmed*).
  2. Immutability. ADRs are historical records. Never edit the decision after the fact — supersede with a new ADR and link Superseded by ADR-{NNN} on the old one.
  3. Short is better. 200–500 words is ideal. If longer, move detail to a linked design doc or RFC.
  4. Date everything. What seems obvious now will not be in three years.
  5. Confirm before writing. Suggest the file path in Step 5; write only after the user confirms placement.

Sibling skills

Reach for these at any point in the flow:

  • /create-rfc — the decision has not been made yet. Use RFC to propose options, gather feedback, and drive alignment. Once the decision is made, come back to /create-adr to record it.
  • /forge — spec-driven implementation. Use /forge specify | design | plan | execute when the ADR is decided and you need to build the thing. An ADR often lands as a link in a forge design.md.

Attribution

Based on create-adr by Tech Leads Club, licensed under CC-BY-4.0. Changes have been made to the original.

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.