docs-qa
Skill4 starsChanged 16 days agoMITView on GitHub
Audit this project's documentation for SSoT violations — conflicting truths, duplicated facts, stale pointers, and verbose comment blocks acting as documentation. Trigger on requests like "audit the docs", "check for conflicting truths", "docs drift", "is this documentation duplicated anywhere".
In this repository14 other files it gives its agents.
- .claude/agents/CLAUDE.mdCLAUDE.md
- CLAUDE/CLAUDE.mdCLAUDE.md
- CLAUDE.mdCLAUDE.md
- .claude/skills/CLAUDE.mdCLAUDE.md
- docs/CLAUDE.mdCLAUDE.md
- src/CLAUDE.mdCLAUDE.md
- tests/CLAUDE.mdCLAUDE.md
- acceptance-testSkill
- configureSkill
- docs-optimiseSkill
- hooks-daemonSkill
- issue-sdlcSkill
- modeSkill
- releaseSkill
The file
Files
Documentation QA
This skill is a shim. It carries no documentation body of its own — it
exists to dispatch the hooks-daemon-docs-qa agent, which does the real
work. Where the documentation subsystem is enabled, the ruleset it enforces
is written up in CLAUDE/DocumentationStrategy.md; the agent carries a
compressed model of the same rules for projects that have not enabled it.
What to do
Dispatch the hooks-daemon-docs-qa agent (Task tool,
subagent_type: "hooks-daemon-docs-qa") with:
- the scope the user asked for (a topic, a plan folder, or "the whole corpus" if unstated)
- a pointer to run the deterministic checks first:
hooks-daemon docs-qa --sweep --json - a pointer to the comment-block finder for its Decision-7 hunt:
hooks-daemon find-comment-blocks <source-root> --json
/docs-qa # full-corpus audit
/docs-qa CLAUDE/Plan/00284 # scoped to one plan folder's topicThe agent is read-only — it delivers findings inline, as its final
report, and never edits anything or writes a report file on its own
initiative. If you want the findings persisted (e.g. to
untracked/reports/), name that target explicitly when dispatching it.
Review its report and act on the findings yourself (or ask it to be
dispatched again after you have made changes, to re-verify).
If the agent is not deployed
hooks-daemon-docs-qa ships opt-in (agents.docs_qa.enabled: false by
default). If the Task dispatch fails because the agent is not found, tell
the user to enable it in .claude/hooks-daemon.yaml:
agents:
docs_qa:
enabled: truethen run hooks-daemon restart (or the next daemon upgrade/install run) to
deploy it into .claude/agents/hooks-daemon-docs-qa.md.
Bundled finder scripts
scripts/ bundles thin wrappers over the deterministic CLI, for a human or
the agent to run directly without recalling the exact daemon subcommand:
scripts/sweep.sh—hooks-daemon docs-qa --sweep --jsonscripts/find-comment-blocks.sh <path>...—hooks-daemon find-comment-blocks <path>... --json
Both are finders: they LIST candidates, they never judge content and never gate a tool call. Judgement is the agent's job (or the reviewing human's).
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
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.

