documentation-accuracy-auditor
Skill0 starsChanged 18 days agoMITView on GitHub
Verify README, setup, examples, commands, API docs, screenshots/claims, and paths against the current repository. Use after implementation or before release.
In this repository42 other files it gives its agents.
- AGENTS.mdAGENTS.md
- completion-claims-auditorSkill
- existing-work-preservationSkill
- mcp-reliability-auditorSkill
- multi-agent-integration-reviewerSkill
- project-context-recoverySkill
- requirement-traceability-auditorSkill
- scope-drift-guardSkill
- architecture-complexity-auditorSkill
- dependency-cycle-auditorSkill
- database-schema-reviewerSkill
- data-consistency-auditorSkill
- migration-safety-reviewerSkill
- loop-breakerSkill
- reproduction-builderSkill
- root-cause-debuggerSkill
- dependency-grounding-auditorSkill
- ci-failure-investigatorSkill
- cross-platform-readiness-auditorSkill
- environment-config-auditorSkill
- environment-parity-auditorSkill
- production-readiness-auditorSkill
- token-efficient-workflowSkill
- accessibility-auditorSkill
- dead-feature-detectorSkill
- responsive-design-auditorSkill
- ux-state-completeness-auditorSkill
- release-verification-agentSkill
- agent-tool-trust-auditorSkill
- authentication-security-auditorSkill
- authorization-boundary-auditorSkill
- dependency-vulnerability-auditorSkill
- injection-risk-auditorSkill
- input-validation-auditorSkill
- secret-leakage-detectorSkill
- security-misconfiguration-auditorSkill
- api-contract-auditorSkill
- integration-reality-checkerSkill
- missing-test-detectorSkill
- regression-detectorSkill
- test-quality-auditorSkill
- ui-flow-verifierSkill
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 8 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈8
Distinctive · estimate
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
- could be automatic: a setting could enforce it
- Distinctive: line 20
Read applicable repository instructions before edits.
- Very specific: line 33
Check referenced files/anchors/paths exist and internal links resolve.
- Distinctive: line 34
Run quick-start and representative commands in a clean/local environment when feasible.
- Distinctive: line 36
Verify screenshots or benchmark/status claims have corresponding current evidence.
- Distinctive: line 37
Check installation instructions do not expose secrets or rely on undeclared global state.
- Distinctive: line 38
Run link/doc validation and record external links that could not be checked.
- Distinctive: line 46
Do not fabricate badges, benchmark results, screenshots, download counts, or compatibility claims.
- Distinctive: line 50
All local links/paths and runnable commands in the reviewed scope are verified.
- Distinctive: line 63
If an external link/service cannot be reached, leave the link only when authoritative and mark runtime validation separately rather than …
≈ “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.
Files
Purpose
Prevent documentation from describing a project that no longer exists.
When to activate
Code/config/CLI behavior changed or documentation is being prepared for publication.
When not to activate
Internal refactor has no externally documented behavior and all generated docs are unaffected.
Preconditions
- Read applicable repository instructions before edits.
- Preserve unrelated working-tree changes and establish a baseline when the workflow can modify code.
- Identify which tools and environments are actually available; do not claim unavailable checks ran.
Required inputs
- Documentation files
- Current CLI/API/config
- Build/test environment
Workflow
- Extract executable claims from docs: commands, filenames, flags, endpoints, versions, outputs, supported environments, badges, and feature status.
- Check referenced files/anchors/paths exist and internal links resolve.
- Run quick-start and representative commands in a clean/local environment when feasible.
- Compare API/CLI examples to current parser/schema/types and update stale output/options.
- Verify screenshots or benchmark/status claims have corresponding current evidence; remove stale/unsupported claims.
- Check installation instructions do not expose secrets or rely on undeclared global state.
- Run link/doc validation and record external links that could not be checked.
Relevant tools
Repository search, CLI --help, link checker when available, clean environment.
Safety restrictions
Do not fabricate badges, benchmark results, screenshots, download counts, or compatibility claims.
Validation
- All local links/paths and runnable commands in the reviewed scope are verified.
- Feature/status claims match validation evidence.
- Known environment prerequisites and limitations are explicit.
Expected output
- Documentation claim audit
- Commands actually run
- Broken/stale items fixed
- Unverified external references
Failure handling
If an external link/service cannot be reached, leave the link only when authoritative and mark runtime validation separately rather than inventing accessibility.
Completion criteria
The skill is complete only when every applicable validation item above has observed evidence or is explicitly marked not executed with the concrete blocker. Do not replace missing evidence with confidence language.
Research mapping
This skill was selected from research problems: P051. See research/vibe-coding-problems.md and research/problem-evidence.csv in the Vibe Coding Skills repository.
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.

