adr
Skill0 starsChanged 3 months agoMITView on GitHub
Write an Architecture Decision Record. Use when a decision is hard to reverse — technology choice, service boundary, data model, protocol, vendor, or anything a future engineer will ask "why on earth" about.
97 other projects use a version of this.
Adopted by
Most recently taken up by
- lyeyixian/skillstheir own version, first seen Nov 16, 2026
- raphaeldiscky/skillstheir own version, first seen Nov 16, 2026
- zazencodes/skillstheir own version, first seen Nov 15, 2026
- timursafiullin/aodtheir own version, first seen Nov 15, 2026
- srinator22/agent-kerneltheir own version, first seen Nov 15, 2026
- GravionLabs/skillstheir own version, first seen Nov 15, 2026
Used with
Projects with it also use fdr, sweep and 8 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
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
montymiSkilltech-spec
Parse and review Technical Specification documents for completeness, consistency, and implementation readiness
Also in 3 projects that use this
OpenAISkillobservability
Vercel Observability expert guidance — Drains (logs, traces, speed insights, web analytics), Web Analytics, Speed Insights, runtime logs, custom events, OpenTelemetry integration, and monitoring dashboards. Use when instrumenting, debugging, or optimizing application performance and user experience on Vercel.
Also in 8 projects that use this
JohnJBorenSkillci-cd
CI/CD pipeline design, GitHub Actions, testing automation, and deployment strategies
Also in 4 projects that use this
Other versions97 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 97
- CrowdDotDev/crowd.dev★ 3.4ksame name
- chattocorp/chatto★ 3ksame name
- Cosmian/kms★ 378same name
- linuxfoundation/insights★ 292same name
- rvdbreemen/OTGW-firmware★ 217same name
- sd0xdev/sd0x-dev-flow★ 192same name
- sd0xdev/sd0x-harness★ 192same name
- irahardianto/awesome-agv★ 157same name
- jellydn/my-ai-tools★ 129same name
- EmeaAppGbb/spec2cloud★ 100same name
87 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 repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .claude/commands/agents.mdAGENTS.md
- .opencode/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/caveman.mdcCursor rule
- agent-registrySkill
- cost-reviewSkill
- data-contractSkill
- delegation-protocolSkill
- marketplaceSkill
- onboardingSkill
- orchestrationSkill
- postmortemSkill
- runbookSkill
- threat-modelSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 2 are distinctive, and 1 is very specific to this project.
0
Common
Most of the 81 edited versions we read keep these.
2
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 10
Write an ADR when the decision is expensive to reverse.
- Distinctive: line 13
Do not write one for: library version bumps, naming, formatting, or anything a single pull request can undo.
- Very specific: line 87
Never delete an ADR — set Status: Superseded by NNNN.
“Common” is measured: kept by at least 6 in 10 of the 81 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
ADR
When to write one
Write an ADR when the decision is expensive to reverse. The test: would undoing this in six months require a migration, a rewrite, or a contract negotiation? Then it needs a record.
Do not write one for: library version bumps, naming, formatting, or anything a single pull request can undo.
Location
docs/adr/NNNN-kebab-title.md. Sequential, zero-padded, never renumbered — links rot otherwise.
Template
# NNNN. <Title stated as the decision, not the problem>
- Status: Proposed | Accepted | Superseded by NNNN
- Date: YYYY-MM-DD
- Deciders: <names or agent roles>
## Context
<The forces. Facts and constraints only — no narrative, no history lesson.
What makes this hard? What did we measure? What are we not allowed to change?>
## Decision
<What we will do, active voice, present tense. "We will shard by tenant_id."
Not "it was decided that sharding might be considered.">
## Consequences
<What becomes easier. What becomes harder. What we now owe — the debt this creates.
Include the ugly ones; the ADR is worthless if it only lists benefits.>
## Alternatives Considered
<Each real option with the concrete, specific reason it lost.>Worked example
Two versions of the same Alternatives section:
Weak — unfalsifiable, tells a future reader nothing:
## Alternatives Considered
- Sharding by user_id: not a good fit for our use case.
- Read replicas: didn't scale well enough.
- Bigger instance: too expensive.Strong — every rejection is a checkable fact:
## Alternatives Considered
- **Shard by user_id.** Rejected: 38% of queries join across users within one tenant,
which becomes cross-shard. Measured on 7 days of query logs (`analysis/shard-key-2026-03.md`).
- **Read replicas only.** Rejected: writes are the bottleneck, not reads.
Write throughput is 4.2k/s against a measured single-primary ceiling of ~5k/s;
this buys roughly four months of growth at the current 12%/month rate.
- **Vertical scale to the largest instance.** Rejected: +$18k/month for a 1.8x ceiling,
and the next step after that does not exist. Delays the same decision by two quarters.The second version survives the question "did you actually consider this?" The first does not.
Anti-patterns
| Anti-pattern | Fix |
| Consequences lists only benefits | Every real decision costs something. Name it. |
| "Best practice" as a justification | Cite the measurement or the constraint instead. |
| Alternatives that were never seriously considered | Straw men are worse than omission — delete them. |
| Deleting a superseded ADR | Supersede it. The reasoning stays valuable even when wrong. |
| Written after implementation to satisfy process | The record exists to shape the decision, not to document it. |
| Two decisions in one ADR | Split. They will be superseded on different timelines. |
Rules
- One decision per record.
- Never delete an ADR — set
Status: Superseded by NNNN. - Quantify trade-offs in money, latency, or effort. "Faster" is not a consequence.
- Deciders are named. An unowned decision is a rumour.
Done when
- The title states the decision, not the problem.
- Context contains facts and constraints — no story.
- Consequences include at least one genuine cost.
- Every alternative has a specific, checkable rejection reason.
- A stranger could re-derive the decision from the record alone.
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.

