write-an-adr
Skill735 starsChanged 35 days agoMITView on GitHub
Write an Architectural Decision Record (ADR) to document a significant design choice. Use when user asks to write/create/document an ADR, or to record an architectural decision.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- jalbarrang/skillstheir own version, first seen Aug 23, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
- jalbarrang/skills★ 2same 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 repository18 other files it gives its agents.
- AGENTS.mdAGENTS.md
- build-repo-contextSkill
- check-trajectories-workflowSkill
- ci-maintenance-workflowSkill
- code-quality-fix-allSkill
- code-quality-review-allSkill
- create-evalSkill
- ensure-test-coverageSkill
- eval-quality-workflowSkill
- eval-report-workflowSkill
- eval-validity-reviewSkill
- generate-asset-actionsSkill
- investigate-datasetSkill
- prepare-releaseSkill
- prepare-submission-workflowSkill
- read-eval-logsSkill
- security-audit-evalSkill
- verify-scoring-changeSkill
The file
We split this skill into the rules it gives an agent
6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
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
- Distinctive: line 21
If the user hasn't described the decision clearly, ask clarifying questions before writing
- Distinctive: line 37
If the user has already provided this information (e.g., in a design doc, PR discussion, or prior conversation), extract it rather than …
- Distinctive: line 62
One decision per ADR: If a design doc contains multiple decisions, write separate ADRs for each.
- Distinctive: line 65
Immutable once accepted: Don't edit accepted ADRs to reflect new information.
- Distinctive: line 74
If the user provides a design doc or PR discussion as input, extract the decision and context from it rather than asking the user to repeat …
- Distinctive: line 75
Do not stage or commit the ADR without asking the user first
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Write an Architectural Decision Record (ADR)
An ADR captures a single architecturally significant decision and its rationale. ADRs are stored in the adr/ directory at the repo root, numbered sequentially.
Background
This workflow follows the Nygard ADR format (Status, Context, Decision, Consequences) with practical additions (Date, Rationale, Considered Options) drawn from MADR and the project's existing conventions. See:
Prerequisites
- The user describes a decision that has been made (or is being proposed)
- If the user hasn't described the decision clearly, ask clarifying questions before writing
Steps
Determine the next ADR number:
- List files in
adr/and find the highest existing number - Increment by 1, zero-padded to 4 digits (e.g.,
0002)
- List files in
Gather information from the user:
- What problem or issue motivated this decision?
- What was decided?
- What alternatives were considered (if any)?
- What are the expected consequences (positive, negative, neutral)?
- What is the current status? (default:
Proposed) - If the user has already provided this information (e.g., in a design doc, PR discussion, or prior conversation), extract it rather than asking again
- Write the ADR at
adr/NNNN-<slug>.mdusing the template below. The slug should be a short kebab-case summary of the decision (e.g.,use-huggingface-for-assets). - Review with the user: Show them the file path and ask if they'd like any changes before considering it done.
Template
The ADR must use the structure in assets/adr-template.md. Copy that file as the starting point, then fill in the placeholders. All sections are required unless marked optional. Write in plain, direct language — avoid jargon and filler.
Placeholder guidance
| Placeholder | What to write |
{TITLE} | A short noun phrase describing the decision (e.g., "Use HuggingFace Hub for Asset Hosting"). |
{STATUS} | One of: Proposed, Accepted, Rejected, Deprecated, Superseded. Default to Proposed. If superseded, add a line: Superseded by [ADR-NNNN](NNNN-slug.md). If this supersedes another, add: Supersedes [ADR-NNNN](NNNN-slug.md). |
{DATE} | YYYY-MM-DD — the date the decision was made or proposed. Use today's date unless the user specifies otherwise. |
{CONTEXT} | The problem or situation motivating this decision. Describe forces at play — technical constraints, business requirements, team preferences, prior art. Reference issues, PRs, or prior ADRs. Should be understandable by someone unfamiliar with the history. |
{OPTION_A/B} | If multiple approaches were evaluated, list them with pros/cons. Optional for straightforward decisions, recommended when the choice was non-obvious. |
{DECISION} | The change being made. State clearly and concisely. Use active voice ("We will...", "Each eval will..."). Include enough detail to understand the change without reading the full implementation. |
| Consequences | Positive: what becomes easier, better, or more reliable. Negative: what becomes harder or more complex. Neutral (optional): side effects that are neither clearly positive nor negative. |
{RATIONALE} | Optional. If the reasoning isn't fully captured by Context + Consequences, explain why this option was chosen. Especially useful when the decision is surprising or counterintuitive. |
Guidelines
- One decision per ADR. If a design doc contains multiple decisions, write separate ADRs for each.
- Keep it short. A good ADR is 1-2 pages. If Context is getting long, link to a design doc instead of duplicating it.
- Write for future readers. Someone joining the team in 6 months should understand why this decision was made.
- Immutable once accepted. Don't edit accepted ADRs to reflect new information. Instead, write a new ADR that supersedes the old one.
- Status lifecycle: Proposed → Accepted (or Rejected). Later: Deprecated or Superseded.
- Link liberally. Reference PRs, issues, design docs, and other ADRs.
- Use today's date unless the user specifies a different date for the decision.
Notes
- The
Considered OptionsandRationalesections are optional but encouraged for non-trivial decisions - The
Neutralsubsection under Consequences is optional - If the user provides a design doc or PR discussion as input, extract the decision and context from it rather than asking the user to repeat themselves
- Do not stage or commit the ADR without asking the user first
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.

