agentleFS
lautioliverlautioliver/barrilete-kit/.claude/skills/update-docs/SKILL.md

update-docs

Skill6 starsChanged 7 days agoMITView on GitHub

Detects which documentation became outdated because of a change and fixes it. Use before opening a PR (implement-issue calls it), with "/update-docs", "update the docs", "which docs went stale?" or to fix gaps between docs and code.

90 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use get-pr-reviews, push-everything 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.
  • saffron-healthSkill

    get-pr-reviews

    Get nicely formatted output of the last review comments on a PR. Used internally by other skills.

    Also in 3 projects that use this

  • saffron-healthSkill

    push-everything

    Stage ALL changes in the repository (not just session changes), commit, and push. Use when you need to commit all pending changes.

    Also in 3 projects that use this

  • TheKREATORSSkill

    instinct-export

    Export instincts from project/global scope to a file

    Also in 3 projects that use this

  • TheKREATORSSkill

    instinct-import

    Import instincts from file or URL into project/global scope

    Also in 3 projects that use this

  • NVIDIASkill

    generate-spec

    Produce a feature specification covering API changes, backward compatibility, cross-language impact, performance, and a file-level change plan. Use when designing a new feature, planning a significant change, or the user asks to spec something out.

    Also in 3 projects that use this

  • belokonmSkill

    fullstack-developer

    End-to-end feature expert specializing in frontend-backend integration, system architecture, and complete application development

    Also in 4 projects that use this

  • +1 more from saffron-health
  • +1 more from TheKREATORS

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 84 edited versions we read keep these.

  • 2

    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. Very specific:

    Run check-docs.py (broken links and paths are the cheapest symptom).

    line 37
  2. Distinctive:

    Do not invent behavior that is not in the code or in the diff.

    line 43
  3. Very specific:

    Do not move content from horizon.md or roadmap.md into architecture.md if it is not implemented.

    line 44
  4. Distinctive:

    Do not rewrite accepted ADRs.

    line 45

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

Update docs

Agents work with what the docs say. If a doc says something the code no longer does, the next agent will build on something false. This skill keeps the docs in step with the code.

Underlying rule (docs/README.md): if a doc and the code do not match, the code wins and the doc is fixed. Exception: if the doc is an ADR, the code may be wrong; in that case, ask.

Mode 1: after a change (the usual one)

  1. What to touch:
    python3 scripts/agents/agents_map.py            # current branch against the base
    python3 scripts/agents/agents_map.py --pr <n>   # or a PR
    It lists the docs that the map (docs/agents-map.json) associates with the changed files, marking those that are still NOT MODIFIED.
  2. Review each one against the diff (git diff <base>...HEAD). The map suggests; you decide. A listed doc may need no changes (the change does not alter what it describes), and an unlisted doc may need them.
  3. Besides the map, always check:
    • Did a command or a convention change? → AGENTS.md.
    • Did an ADR decision change? → do not rewrite it: amend with a date or a new ADR (docs/decisions/README.md). This requires asking (AGENTS.md, "Agent autonomy" section).
    • Did you add a document with content? → docs/README.md and docs/llms.txt.
    • A new domain term? → docs/reference/glossary.md.
  4. Write. Minimal, precise changes: describe what is there, not the history of the change (that goes in the PR). Do not duplicate canonical lists: if the list lives in another file, link to it.
  5. Validate:
    python3 scripts/agents/check-docs.py
  6. Report which docs you changed and which ones from the map you decided not to touch and why. This goes in the PR.

Mode 2: audit old gaps

With "which docs went stale?" or "check that architecture.md is up to date":

  1. Run check-docs.py (broken links and paths are the cheapest symptom).
  2. For each doc in docs/reference/ and docs/development/architecture.md, compare what it claims with the code: endpoints, tables, modules, commands. Prioritize what an agent would use to decide.
  3. List the gaps found with file and line. Fix the small ones in a docs(docs): … PR; the big ones, as issues (create-issue, type:docs).

Do not

  • Do not invent behavior that is not in the code or in the diff.
  • Do not move content from horizon.md or roadmap.md into architecture.md if it is not implemented.
  • Do not rewrite accepted ADRs.

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.