agentleFS
nfeuernfeuer/project-foundation-kit/.claude/skills/adr/SKILL.md

adr

Skill0 starsChanged 4 months agoMITView on GitHub

Create an Architecture Decision Record when a non-obvious design choice is made — captures context, options, rationale, and tradeoffs in a durable doc

97 other projects use a version of this.

Adopted by

Most recently taken up by

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.
  • thiagofgfSkill

    fdr

    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

  • AnthropicSkill

    runbook

    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

  • drewdrewthisSkill

    sweep

    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

  • vndeeSkill

    product-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

  • OpenAISkill

    threat-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

  • montymiSkill

    tech-spec

    Parse and review Technical Specification documents for completeness, consistency, and implementation readiness

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 5

    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:

    Write one whenever you make a choice that isn't obvious from the code alone — not for every line, but for every fork in the road where the …

    line 15
  2. Distinctive:

    Write an ADR when:

    line 21
  3. Distinctive:

    Do not write an ADR for: implementation details obvious from the code, stylistic choices already covered by the linter, or work that …

    line 30
  4. Distinctive:

    Keep each section tight — a few sentences per section is usually enough.

    line 59
  5. Distinctive:

    If it implements a spec section, add a note in that section's prose or a cross-reference comment.

    line 67
  6. Very specific:

    If it opens a follow-up, append an entry to docs/followups.md referencing the ADR ID.

    line 69
  7. Very specific:

    If a future decision overturns this one, mark the old ADR superseded by NNNN-new-slug.md and write a new ADR explaining the reversal.

    line 73

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

ADR

An Architecture Decision Record (ADR) is a short document that answers the question a future engineer will inevitably ask: "Why did we do it this way?" Write one whenever you make a choice that isn't obvious from the code alone — not for every line, but for every fork in the road where the alternative was real and the reasoning should survive the PR.

When to write one

Write an ADR when:

  • You chose one technology, library, or pattern over a concrete alternative.
  • You made a tradeoff that will constrain future work (performance vs simplicity, consistency vs availability, etc.).
  • You deviated from the spec or from a previous ADR.
  • You rejected an approach that looks attractive so the team doesn't re-litigate it later.
  • Future-you, reading a git blame six months from now, would ask "huh, why?"

Do not write an ADR for: implementation details obvious from the code, stylistic choices already covered by the linter, or work that implements a decision already recorded.

Workflow

1. Pick the next sequence number

ls docs/decisions/ | grep -E '^[0-9]{4}-' | tail -1

Increment by one, zero-padded to four digits (e.g. 0003 → 0004).

2. Choose a slug

Short, lowercase, hyphenated title: use-sqlite-wal-mode, reject-celery, model-abstraction-layer. The file will be docs/decisions/NNNN-slug.md.

3. Fill in the template

Copy templates/adr.template.md to docs/decisions/NNNN-slug.md and replace every <placeholder>:

  • Context — the situation that forced a decision; constraints in play.
  • Decision — what you chose, in one clear sentence.
  • Options considered — at least two, with honest pros/cons for each. Include the option you rejected — that's often the most valuable part.
  • Consequences — what becomes easier, what becomes harder, what is now locked in.
  • Related — the spec section it implements or diverges from (spec_v3.md §N), any follow-up IDs (docs/followups.md), and the PR that introduced it.

Keep each section tight — a few sentences per section is usually enough; the value is in the decision and the rejected alternatives, not exhaustive prose.

Set Status to proposed until the PR is merged, then accepted.

4. Cross-link

In the same PR:

  • Cite the ADR path in the PR description.
  • If it implements a spec section, add a note in that section's prose or a cross-reference comment.
  • If it opens a follow-up, append an entry to docs/followups.md referencing the ADR ID.

5. Superseding an ADR

If a future decision overturns this one, mark the old ADR superseded by NNNN-new-slug.md and write a new ADR explaining the reversal. Never delete an old ADR — the rejection history is the point.

Output

## ADR Created

- Path:    docs/decisions/<NNNN-slug>.md
- Status:  proposed → accepted on merge
- Summary: <one sentence: what was decided and why>
- Related: <spec §N | follow-up ID | PR #N>

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.