adr
Skill84 starsChanged 29 days agoMITView on GitHub
Write or update an Architecture Decision Record in docs/adr. Use when a decision affects structure, a public interface, a data format, a dependency, or another repository, or when asked to "record a decision" or "write an ADR". Also use before proposing a change that might conflict with an existing ADR.
90 other projects use a version of this.
Adopted by
Most recently taken up by
- GustavoAlecio/claude-setuptheir own version, first seen Nov 8, 2026
- computerlovetech/skillstheir own version, first seen Nov 8, 2026
- rvdbreemen/OTGW-firmwaretheir own version, first seen Nov 8, 2026
- axodouble/skillstheir own version, first seen Nov 8, 2026
- RodrigoAnciaes/golem-sddtheir own version, first seen Nov 8, 2026
- n1kben/agentstheir own version, first seen Nov 8, 2026
Used with
Projects with it also use fdr, runbook and 10 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.
thiagofgfSkillfdr
Use when creating, changing, reviewing, retiring, auditing, or backfilling implemented user-visible feature behavior, permissions, feature-specific rationale, tradeoffs, or relationships to architectural decisions.
Also in 3 projects that use this
AnthropicSkillrunbook
Create or update an operational runbook for a recurring task or procedure. Use when documenting a task that on-call or ops needs to run repeatably, turning tribal knowledge into exact step-by-step commands, adding troubleshooting and rollback steps to an existing procedure, or writing escalation paths for when things go wrong.
Also in 5 projects that use this
drewdrewthisSkillsweep
Search for similar patterns, anti-patterns, or issues elsewhere in the codebase after a fix or feature. Use after implementing a fix to catch the same bug in other places, or proactively to audit for a known pattern.
Also in 4 projects that use this
vndeeSkillproduct-spec
Use when starting a new feature, product, or project — before any architecture or code, to define what to build and why
Also in 3 projects that use this
OpenAISkillthreat-model
Use when Codex is already in the threat-modeling phase of a security scan, the user explicitly invokes $threat-model, or the user explicitly asks to create, update, or persist a repository threat model. Do not use as the primary trigger for full PR, commit, branch, patch, or repository scans.
Also in 6 projects that use this
montymiSkilltech-spec
Parse and review Technical Specification documents for completeness, consistency, and implementation readiness
Also in 3 projects that use this
Other versions90 projects use a version of this.
Word for word · 1
- theagentplane/control-plane★ 4100% same
Edited · 0
None found.
Wrote their own version · 89
- CrowdDotDev/crowd.dev★ 3.4ksame name
- chattocorp/chatto★ 2.9ksame name
- Cosmian/kms★ 372same name
- linuxfoundation/insights★ 288same name
- rvdbreemen/OTGW-firmware★ 213same name
- sd0xdev/sd0x-dev-flow★ 192same name
- sd0xdev/sd0x-harness★ 192same name
- irahardianto/awesome-agv★ 157same name
- jellydn/my-ai-tools★ 127same name
- EmeaAppGbb/spec2cloud★ 100same name
79 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 repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- integrate-tokenopsSkill
- raise-issueSkill
- integrate-tokenopsSkill
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 4 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 74 edited versions we read keep these.
4
Distinctive
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 13
Write one when the decision changes structure, a public interface, a data format or schema, a significant dependency or tool, is hard to …
- Distinctive: line 37
Keep it to about one page.
- Very specific: line 49
Add a row to the index table in docs/adr/README.md.
- Distinctive: line 53
Never rewrite an accepted ADR's content.
- Distinctive: line 54
Write a new ADR, set its "Supersedes" field, and in the old ADR change only the status to
“Common” is measured: kept by at least 6 in 10 of the 74 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
Writing an Architecture Decision Record
ADRs live in docs/adr/. The rules and index are in docs/adr/README.md; the template is
docs/adr/template.md. Read the README first.
1. Decide whether an ADR is needed
Write one when the decision changes structure, a public interface, a data format or schema, a significant dependency or tool, is hard to reverse, or affects another repository. Do not write one for a bug fix, a rename or a small refactor. If unsure, ask the user.
2. Check what already exists
List docs/adr/. Read ADRs that touch the same area. If the new decision conflicts with an
accepted ADR, it must supersede it explicitly; do not quietly contradict it.
3. Create the file
- Number: the highest existing
NNNNplus one, zero-padded to four digits. - Name:
docs/adr/NNNN-short-kebab-title.md. The title states the decision in present tense ("Use X for Y"), not the topic ("Y storage"). - Copy
docs/adr/template.mdand fill it in.
4. Fill it in honestly
- Context: verifiable facts only. Read the code or documents rather than guessing.
- Options considered: the real alternatives, each with honest good and bad points.
- Decision: one clear sentence, then the reasons that decided it.
- Consequences: include what gets worse or riskier. An ADR with only benefits is unfinished.
- Impact on other repositories: list each affected repo (chronicle, primitives, control-plane, tokenops) and what must change there, or write "none".
- Keep it to about one page; link to longer material.
- If you do not know the reasoning or the alternatives that were weighed, ask the user. Never invent rationale.
5. Status and people
- Set status to Proposed. Only set Accepted when the user says the decision has been made, and then record who decided in the Deciders field. Use the names of people, not "Claude".
- Set the date to today.
6. Update the index
Add a row to the index table in docs/adr/README.md.
7. Superseding or changing a decision
- Never rewrite an accepted ADR's content. Fixing a typo is fine.
- Write a new ADR, set its "Supersedes" field, and in the old ADR change only the status to Superseded and add a "Superseded by" link.
8. Report back
Tell the user the file path, the one-sentence decision, and any open question you could not answer without them.
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.