agentleFS
jamie8johnsonjamie8johnson/cqs/.claude/skills/docs-review/SKILL.md

docs-review

Skill18 starsChanged 5 months agoMITView on GitHub

Review project docs for staleness. Checks lib.rs, Cargo.toml, README, CONTRIBUTING, SECURITY, PRIVACY, and GitHub repo metadata.

27 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

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

The file

We split this skill into the rules it gives an agent

11 rules. 0 are common, 10 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 26 edited versions we read keep these.

  • 10

    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 all project documentation for staleness and fix what's drifted.

    line 9
  2. Distinctive:

    Run git log vLAST_TAG..HEAD --stat to see what changed since last release

    line 14
  3. Distinctive:

    If no tag exists, review everything

    line 16
  4. Distinctive:

    If unsure about a claim, flag it rather than guessing

    line 34
  5. Very specific:

    Before releases (/release references this)

    line 38
  6. Distinctive:

    After significant feature PRs

    line 39
  7. Distinctive:

    When you suspect drift

    line 41
  8. Distinctive:

    Don't rewrite docs for style — only fix factual staleness

    line 45
  9. Distinctive:

    Don't add content — only correct what exists

    line 46
  10. Distinctive:

    Check numbers against code: grep for hardcoded counts (languages, tests, dimensions) and verify

    line 47
  11. Distinctive:

    If CONTRIBUTING.md Architecture Overview lists files, glob to confirm they exist

    line 48

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

Docs Review

Check all project documentation for staleness and fix what's drifted.

Process

  1. Scope the review:
    • Run git log vLAST_TAG..HEAD --stat to see what changed since last release
    • Focus on docs affected by those changes
    • If no tag exists, review everything
  2. Check each item:

    FileWhat to check
    src/lib.rs doc commentLanguage count, feature list, API examples compile, Quick Start accuracy
    Cargo.tomldescription (crates.io one-liner), keywords, categories
    README.mdHardcoded versions (schema, install), feature list, usage examples, badge URLs
    CONTRIBUTING.mdArchitecture Overview matches current file layout — any files added/moved/renamed?
    SECURITY.mdThreat model current, dependency notes, any new attack surfaces?
    PRIVACY.mdData handling claims still accurate?
    CLAUDE.mdSkills list matches .claude/skills/; Project Conventions accurate (MSRV, feature names); WSL/CI guidance not contradicting current practice
    GitHub repoDescription and topics — gh repo view, update with gh repo edit if needed
  3. Fix and report:
    • Fix stale docs directly
    • Report what was updated and what was already current
    • If unsure about a claim, flag it rather than guessing

When to run

  • Before releases (/release references this)
  • After significant feature PRs
  • Before audits
  • When you suspect drift

Rules

  • Don't rewrite docs for style — only fix factual staleness
  • Don't add content — only correct what exists
  • Check numbers against code: grep for hardcoded counts (languages, tests, dimensions) and verify
  • If CONTRIBUTING.md Architecture Overview lists files, glob to confirm they exist

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.