write-adr
Skill2 starsChanged 16 days agoMITView on GitHub
Record an architecture decision for Heinzelmännchen as an ADR in docs/adr. Use before a structural change (new module kind, let kind, head, dependency, process change), when a change contradicts an existing ADR, or when asked to document a decision.
15 other projects use a version of this.
Adopted by
Most recently taken up by
- seancabalse/agentic-playbooktheir own version, first seen Nov 16, 2026
- miruky/harness-sampletheir own version, first seen Nov 15, 2026
- connext-solutions/flowctltheir own version, first seen Nov 15, 2026
- LeonardoEnnes/ai-engineering-toolkittheir own version, first seen Nov 8, 2026
- adhamhaithameid/write-skillstheir own version, first seen Nov 8, 2026
- 0xdeafcafe/skillstheir own version, first seen Nov 6, 2026
Used with
Projects with it also use security-audit, handoff and 1 more.
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.
CloudflareSkillsecurity-audit
Security guidance and vulnerability review for codebases, APIs, services, CLI tools, libraries, and daemons. Use for security questions, focused reviews, vulnerability research, security audits, or pen tests. Run the complete workflow only for explicit codebase audit or pen-test requests, full/comprehensive/end-to-end reviews, or requested report artifacts.
Also in 3 projects that use this
MicrosoftSkillhandoff
Compact the current conversation into a handoff document for another agent to pick up.
Also in 3 projects that use this
GoogleSkillcode-review
Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.
Also in 3 projects that use this
Other versions15 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 15
- HexamindOrganisation/hexgate★ 25same name
- adhamhaithameid/write-skills★ 1same name
- connext-solutions/flowctl★ 1same name
- daniel-kindl/dkstack★ 1same name
- fabianmagrini/skills★ 1same name
- MaheshAwasare/claude-skills-pro★ 1same name
- tejastn10/workbench★ 1same name
- 0xdeafcafe/skills★ 0same name
- dr-zog/plumbline★ 0same name
- Industrial-AI-Research-Lab/nir-agent-overlay★ 0same name
5 more not listed
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 repository18 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/CLAUDE.mdCLAUDE.md
- starter/CLAUDE.mdCLAUDE.md
- template/CLAUDE.mdCLAUDE.md
- tests/CLAUDE.mdCLAUDE.md
- add-moduleSkill
- add-operationSkill
- codifySkill
- raise-the-barSkill
- releaseSkill
- reviewSkill
- scaffold-pluginSkill
- self-auditSkill
- ship-smallSkill
- write-testsSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 0 are distinctive, and 2 are very specific to this project.
0
Common
Most of the 14 edited versions we read keep these.
0
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
- could be automatic: a setting could enforce it
- Very specific: line 10
Read docs/adr/README.md and the ADRs related to the decision.
- Very specific: line 31
Do not edit the index table of docs/adr/README.md: it is generated.
“Common” is measured: kept by at least 6 in 10 of the 14 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.
Files
Write an ADR
The format is a trimmed MADR 4; docs/adr/0000-template.md is the source of truth.
- Read
docs/adr/README.mdand the ADRs related to the decision; ask thearchitectagent if unsure. - Copy
docs/adr/0000-template.mdtodocs/adr/NNNN-title-in-kebab-case.mdwith the next number; the title is# NNNN: Title that states the decision. Delete the template's comment. - Front matter, flat
key: valueonly:status: proposed,date: YYYY-MM-DD, optionaldecision-makers(roles, never names),supersedes/amendswhen the decision replaces or changes another ADR, andrelatedfor ADRs it builds on without changing them. For each ADR it amends or supersedes, addamends-NNNN: what it changes(a few words, no:or#inside); the index and both pages show it. Setimplementation: planned; it becomespartialorbuiltas code lands. Once a pull request builds the decision, addimplemented-by: 123, 145(PR numbers of the code, never the PR that only wrote the record); leave it out until then. - Fill in, keeping it to a page or two:
- Context and Problem Statement: forces and verified facts, sources linked.
- Decision Drivers (optional).
- Considered Options: the chosen one marked
(chosen), each other one with why not. Never invent options. - Decision Outcome: one line
Chosen option: **...**, because ..., then checkable statements. - Consequences (good and bad) and Confirmation: the enforcing mechanism in two sentences, no file lists (the test, lint rule, import-linter contract or CI job that fails when the decision is broken — grep that it exists), or "review only".
- More Information (optional): related ADRs, research, open questions.
- Superseding or amending: set
superseded-by: NNNNandstatus: superseded(oramended-by: NNNN) on the old ADR. Front matter is the only part of an accepted ADR that may change, plus a dated amendment note ("Amended YYYY-MM-DD: ...") at the end of More Information. - Do not edit the index table of
docs/adr/README.md: it is generated. Runmake docs(in Heinzelmännchen) and commit the result;uv run pytest tests/unit/documentation_test.pychecks template, index and links. - Status stays
proposeduntil a maintainer accepts it. Commit withdocs(adr): ....
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
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.

