agentleFS
cobusgreylingcobusgreyling/grok-bot-templates/skills/detect-docs-drift/SKILL.md

detect-docs-drift

Skill14 starsChanged 3 months agoMITView on GitHub

Paste this into Grok Bot after a successful run: Save the process we just used as a skill called “Detect Docs Drift”. A useful skill states the six fields from Skills and routines. README, API docs, or comments claim behavior that the current code may not match, and the owner needs a draft doc diff — not a commit. Every drift cites a doc path and a code path. No invented APIs. The deliverable is a draft, unpublished. Drift table…

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Do not commit, push, or merge.

    line 25
  2. Distinctive:

    Every drift cites a doc path and a code path.

    line 29
  3. Distinctive:

    Do not commit, merge, or publish the docs.

    line 39

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Detect Docs Drift

Paste this into Grok Bot after a successful run:

Save the process we just used as a skill called “Detect Docs Drift”.

A useful skill states the six fields from Skills and routines.

1. When to use it

README, API docs, or comments claim behavior that the current code may not match, and the owner needs a draft doc diff — not a commit.

2. Required inputs and access

  • GitHub repository or attached docs plus code
  • Paths the owner named (README, API docs, OpenAPI, generated refs)
  • Optional last-known-good tag

3. Sequence of work

  1. Open the named docs and the code they describe (routes, flags, types, CLI).
  2. List each drift as doc claim vs code fact, with paths.
  3. Draft a doc diff the owner can paste. Prefer the smallest truthful edit.
  4. Do not commit, push, or merge. Do not "fix" the code to match a wrong README.

4. How to validate the result

Every drift cites a doc path and a code path. No invented APIs. The deliverable is a draft, unpublished.

5. What to return

Drift table plus a proposed doc patch. Action log of files read.

6. What requires approval

Do not commit, merge, or publish the docs. Do not edit GitHub wiki or the production doc site.

Type / in the composer to reference a saved skill. If it does not appear, open Settings → Plugins → Yours and enable it for this Bot.

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.