agentleFS
Sign inStart free
kjnezkjnez/claude-code-django/.claude/skills/docs-sync/SKILL.md

docs-sync

Skill177 starsChanged 10 months agoMITView on GitHub

Check if documentation is in sync with code. Use when the user wants to verify that documentation matches current code, find outdated docs, or audit documentation accuracy. Triggers on requests like "check docs", "sync documentation", "are the docs up to date", "/docs-sync".

We split this skill into the rules it gives an agent

7 rules. 0 are common, 6 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 33 edited versions we read keep these.

  • 6

    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
  1. Distinctive:

    Check if documentation matches the current code state.

    line 8
  2. Very specific:

    Search /docs/ for files mentioning changed code

    line 18
  3. Distinctive:

    Check README files near changed code

    line 19
  4. Distinctive:

    Look for docstrings in changed files

    line 20
  5. Distinctive:

    Do code examples still work?

    line 23
  6. Distinctive:

    Only flag things that are WRONG, not missing

    line 28
  7. Distinctive:

    Don't suggest documentation for documentation's sake

    line 29

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

Documentation Sync

Check if documentation matches the current code state.

Instructions

  1. Find recent code changes:
    git log --since="30 days ago" --name-only --pretty=format: -- "*.py" "*.ts" "*.tsx" | sort -u
  2. Find related documentation:
    • Search /docs/ for files mentioning changed code
    • Check README files near changed code
    • Look for docstrings in changed files
  3. Verify documentation accuracy:
    • Do code examples still work?
    • Are API signatures correct?
    • Are field types up to date?
  4. Report only actual problems:
    • Only flag things that are WRONG, not missing
    • Don't suggest documentation for documentation's sake
  5. Output a checklist of documentation that needs updating

Download now (ZIP)

  • Other versions43 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 43

    1. openai/openai-agents-python★ 30ksame name
    2. redis/node-redis★ 18ksame name
    3. redis/ioredis★ 15ksame name
    4. fossasia/visdom★ 10ksame name
    5. Kiln-AI/Kiln★ 5.2ksame name
    6. microsoft/apm★ 4.2ksame name
    7. danielmeppiel/apm★ 4ksame name
    8. openai/openai-agents-js★ 4ksame name
    9. pnp/powershell★ 906same name
    10. strands-agents/box★ 490same name

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

  • Used alongsideProjects with it also use code-review, tdd and 1 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.
    • GoogleSkill

      code-review

      Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

      Also in 4 projects that use this

    • GoogleSkill

      tdd

      Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

      Also in 3 projects that use this

    • MicrosoftSkill

      release

      Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

      Also in 3 projects that use this

  • In this repository16 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

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.

Check your setup, free