agentleFS
vhmarquezvhmarquez/argo/skills/adr/SKILL.md

adr

Skill1 starsChanged 7 months agoMITView on GitHub

Manage Architecture Decision Records under docs/adr/. Create new ADRs from a template, list existing ones, mark superseded, and update the index. Use this whenever you make a non-trivial architectural choice that future teammates will want to understand.

90 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

5 rules. 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 75 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run index to update docs/adr/README.md

    line 43
  2. Very specific:

    Read every ${ADR_DIR}/[0-9]*.md and parse the front-matter for id, title, status, date.

    line 47
  3. Very specific:

    Verify ADR <id> exists. Update its status: to Superseded by <next-id>

    line 59
  4. Very specific:

    Create a new ADR via new <new-title> with status Accepted (or Proposed)

    line 60
  5. Distinctive:

    One decision per ADR: If you find yourself writing about two decisions, split them

    line 85

“Common” is measured: kept by at least 6 in 10 of the 75 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

You are managing Architecture Decision Records (ADRs) for this project. ADRs are short Markdown files capturing one decision each — the context, options considered, decision, and consequences. They live in docs/adr/ and are numbered sequentially (0001-..., 0002-...).

Read Project Config First

source "${CLAUDE_PLUGIN_ROOT}/hooks/lib/config.sh"
ADR_DIR="docs/adr"
mkdir -p "$ADR_DIR"

Input

$ARGUMENTS:

  • new <title> — create a new ADR with the next sequential number; use the template
  • list — list existing ADRs in a table (id, title, status, date)
  • supersede <id> <new-title> — mark <id> as superseded and create a new ADR
  • index — regenerate docs/adr/README.md from the contents of the directory
  • (empty) — show usage

Steps

new <title>

  1. Find the next ID:
    NEXT_ID=$(ls "$ADR_DIR"/[0-9][0-9][0-9][0-9]-*.md 2>/dev/null | sed -E 's:.*/([0-9]{4})-.*:\1:' | sort -n | tail -1)
    NEXT_ID=$(printf "%04d" $((10#${NEXT_ID:-0} + 1)))
  2. Slugify the title: lowercase, spaces → -, strip punctuation
  3. Copy the template from ${CLAUDE_PLUGIN_ROOT}/templates/docs/adr/0000-template.md to ${ADR_DIR}/${NEXT_ID}-${SLUG}.md
  4. Substitute placeholders in the new file:
    • {{id}} → e.g., 0007
    • {{title}} → the user-provided title
    • {{date}} → YYYY-MM-DD (today)
    • {{status}} → Proposed
  5. Open the file path in the response so the user can fill it in
  6. Run index to update docs/adr/README.md

list

Read every ${ADR_DIR}/[0-9]*.md and parse the front-matter for id, title, status, date. Print a Markdown table:

| ID   | Title                       | Status      | Date       |
|------|-----------------------------|-------------|------------|
| 0001 | Use Named Credentials       | Accepted    | 2026-02-14 |
| 0002 | Custom Metadata for config  | Accepted    | 2026-03-01 |
| 0003 | Replace ProcessBuilder X    | Superseded by 0007 | 2026-03-08 |

supersede <id> <new-title>

  1. Verify ADR <id> exists. Update its status: to Superseded by <next-id>
  2. Create a new ADR via new <new-title> with status Accepted (or Proposed)
  3. In the new ADR's "Context" section, add a line: "Supersedes ADR-<id>"
  4. Re-run index

index

Walk the directory, parse each ADR's front-matter, and write ${ADR_DIR}/README.md:

# Architecture Decision Records

This index is generated by `/argo:adr index`. Edit the source ADRs, not this file.

| ID | Title | Status | Date |
|----|-------|--------|------|
| 0001 | [Use Named Credentials](0001-use-named-credentials.md) | Accepted | 2026-02-14 |
| ...

ADR Template

Lives at ${CLAUDE_PLUGIN_ROOT}/templates/docs/adr/0000-template.md. The skill copies and substitutes; users edit the body.

Rules

  • One decision per ADR. If you find yourself writing about two decisions, split them
  • Don't delete superseded ADRs. Mark them and link forward — the history is the value
  • Keep them short. The point is "future-me can reconstruct the reasoning in 60 seconds." Aim for under one screen
  • Link to code, not the other way around. Code references the ADR ("see ADR-0007"), but the ADR is stable and self-contained
  • No tracker/jira links as the only context. External links rot — paraphrase the relevant context inline

Consumers

  • @architect, @data-architect, @integration-architect — read ADRs before designing to honor prior decisions
  • /argo:code-review — flags code that contradicts an ADR (e.g., hardcoded endpoint when ADR-0001 mandated Named Credentials)
  • /argo:release-notes — picks up new ADRs since the last release as architecture-change notes

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.