agentleFS
willdadywilldady/platypus/.agents/skills/docs-audit/SKILL.md

docs-audit

Skill130 starsChanged 5 days agoMITView on GitHub

Audit one section of the docs content against the code, and report what is wrong, stale, fragile, off-voice, or missing.

  • Reads credentials

15 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use docs-planner, docs-reviewer and 3 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.
  • strands-agentsSkill

    docs-planner

    Find the gaps in the Box documentation and produce a prioritized backlog for docs/user/ and docs/design/. Use when planning documentation work, after a feature or a binary ships without a page, for a periodic health check of the docs, or when asked "what docs need writing", "plan the docs work", "prioritize the docs backlog", or "what should we document next".

    Also in 3 projects that use this

  • strands-agentsSkill

    docs-reviewer

    Review Box drafts in docs/user/ or docs/design/, and wording-only rewrites in docs/dev/. Use after docs-writer, before a docs pull request, or for a requested doc review. Check style and preservation of meaning, then give a Ship it, Tighten, or Rethink verdict. Read-only.

    Also in 3 projects that use this

  • VercelSkill

    docs-diagrams

    Draw diagrams for the Next.js docs in the style of the ones already published there: the light/dark PNGs an mdx references with `<Image srcLight="/docs/light/<name>.png" srcDark="/docs/dark/<name>.png">`. Use when a guide or API reference needs a new diagram or an existing one needs a change. Hand-written SVG from a primitives library, rendered by headless Chrome at 2x. No AI image generation.

    Also in 3 projects that use this

  • GoogleSkill

    docs-writer

    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

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 12 edited versions we read keep these.

  • 4

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

    Never answer from memory: Every verdict cites a file and a line in the code.

    line 16
  2. Very specific:

    Read each page in the section in full.

    line 41
  3. Distinctive:

    Done when: every page in the section has been read end to end and every claim is on the list with a line number.

    line 52
  4. Very specific:

    run behaviour, steps, timeouts → apps/backend/src/runs/

    line 65
  5. Distinctive:

    Check exhaustive lists in both directions: everything the code has appears in the doc, and everything the doc lists exists in the code.

    line 69
  6. Distinctive:

    Done when: every claim has a verdict and a code citation.

    line 73

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

Audit one section of apps/docs/content against the source, and report every claim that no longer holds.

apps/docs/content/docs-contract.test.ts already pins the claims with exactly one authoritative source — env tables, webhook events, core Plugin names, field limits, internal links, heading anchors. Assume those are green and do not re-check them. Your job is everything that needs judgement, above all the ~150 bolded UI labels across building-with-platypus/, which nothing can see.

Never answer from memory. Every verdict cites a file and a line in the code. A claim you did not open the source for is a claim you did not check.

Step 1 — Pick the section and build the suspect pool

Audit one section per run — one top-level directory of the docs content. List what is actually there rather than working from a remembered set, so a section added since cannot be the one you never audit. Ask the user which if they did not say.

Find when the section was last touched, then list what changed in the code since:

git log -1 --format=%H -- apps/docs/content/<section>
git log <that-sha>..HEAD --oneline -- apps/backend apps/frontend packages/schemas

Drift concentrates where code moved and docs did not, so read that commit list before you read the pages — it tells you which claims to distrust.

Done when: you have the section, the last-touch SHA, and the commit list.

Step 2 — List every claim

Read each page in the section in full. Then write out every falsifiable claim it makes, each with its file:line.

A claim is anything a reader could act on and find wrong: a UI label, a field name, a menu path, a default, a limit, an ordering, a behaviour, a "this requires that", a "you cannot do X".

List every claim, not a sample. Coverage has to be a property of the procedure, because it will not be a property of your attention. A page with sixty claims produces sixty rows.

Done when: every page in the section has been read end to end and every claim is on the list with a line number.

Step 3 — Verify each claim against source

For each claim, open the code that decides it and record the verdict as doc file:line vs code file:line.

Where to look:

  • UI labels, fields, menu paths → apps/frontend/app/**, apps/frontend/components/**
  • limits, enums, required fields → packages/schemas/index.ts
  • endpoints, status codes, errors → apps/backend/src/routes/**
  • run behaviour, steps, timeouts → apps/backend/src/runs/**
  • plugins, Sandboxes, tool sets → apps/backend/src/plugins/**
  • deployment, env, first boot → .example.env, compose*.yaml, apps/backend/index.ts

Check exhaustive lists in both directions: everything the code has appears in the doc, and everything the doc lists exists in the code. A missing row is invisible to a reader — they cannot miss what they were never shown.

Done when: every claim has a verdict and a code citation.

Step 4 — Classify

ClassMeaning
WRONGContradicts the code. A reader following it fails.
STALEWas true, describes something that has since moved or been renamed.
FRAGILETrue today, with no anchor — it will rot and nothing will notice.
TONEAccurate but off-voice against VOICE.md.
GAPThe code does something user-facing that no page mentions.

Step 5 — Report

Rank by reader cost: what breaks a deployment first, then what wastes an hour, then what merely reads badly. Not by page order, and not by how easy the fix is.

For each finding give the doc file:line, the code file:line, what the page says, what the code does, and the proposed edit.

FRAGILE defaults to deletion, not correction. Correcting an anchorless claim resets the clock; deleting it stops the bleeding. Keep it only when it earns its maintenance — say why in the finding. Otherwise the audit's own output becomes next year's backlog.

Close with the claim count, how many you verified, and what you could not check — a claim you could not resolve is a finding, not a silence.

The honest limit

This skill is user-invoked only, so its value is bounded entirely by someone remembering to type it. Nothing schedules it and nothing reminds you. Pair it with a release checklist or /loop, or accept that the contract test is the only thing actually running.

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.