skills.rest
camercu
camercuCOMMUNITY
Explore all skills by this author →
GitHub

user-doc-audit

Audit and rewrite entry documentation by verifying every claim against source code.

2|2|Updated Jun 28, 2015
Search Tags:#documentation#technical writing#audit#readme#docs#accuracy#proofreading
One-click install
npx skills add https://github.com/camercu/dotfiles --skill user-doc-audit-camercu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: user-doc-audit
Source: https://github.com/camercu/dotfiles/tree/main/common/.config/agents/skills/user-doc-audit
Command: npx skills add https://github.com/camercu/dotfiles --skill user-doc-audit-camercu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Entry documents like READMEs and getting-started guides accumulate stale claims, duplicated facts, and unclear structure that mislead evaluators, newcomers, and returning users. ## Core Features & Use Cases - Claim Verification: Inventories every checkable claim (flags, defaults, versions, platforms) and verifies each against code, tests, and --help output. - Audience Audit: Evaluates the doc against three reader types — evaluator, newcomer, and returner — to ensure it pitches, onboards, and refreshes effectively. - De-duplication Enforcement: Collapses facts duplicated across docs into one canonical home with links, preventing documentation drift. - Use Case: Ask whether your README is accurate; the skill reads the whole doc, verifies each claim against the repository, flags false statements, and proposes a restructure before rewriting. ## Quick Start Audit my README for stale or inaccurate information and suggest improvements.

Frequently Asked Questions about user-doc-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit a README for stale information?▼

Read the entire doc and list every checkable claim such as flags, defaults, versions, and platforms. Then verify each claim against the source code, tests, and --help output, flagging anything false as a defect to fix.

How to check if my documentation is accurate against the code?▼

Build a claim inventory from the doc, then confirm each claim empirically by grepping the code, running CLI help commands, and checking the tests that enforce the behavior. External claims should be checked against authoritative upstream sources.

What docs should a README audit cover?▼

The audit targets entry docs: READMEs, docs landing pages, man page intros, and getting-started guides. Reference docs like API sites and full specs are canonical homes you link to, not audit targets.

When should documentation duplication be removed?▼

Remove duplication whenever the same fact lives in two places, since copies drift and eventually one lies. Pick one canonical home for each fact and replace other copies with links, except for sync-tested or operational tables.

What happens when a doc claim cannot be verified?▼

An unverifiable claim may indicate a software defect rather than a doc problem. The skill flags it, follows the thread, and routes the fix to hardening or testing work so the doc records reality instead of papering over bugs.

Related Skills

Explore More Content & Communication Skills→
DreamMacerDreamMacer

doc-update

Audits and updates project documentation against source code as the single source of truth.

Community
Intermediate
StudentCristianStudentCristian

nw-bugfix

Coordinate root-cause analysis, user validation, and regression testing for defect resolution.

Community
Advanced
nodefonynodefony

nodefony-documentation

Write, validate, and publish Nodefony documentation with lint gates and site generation.

Official
Advanced
Skro11XSkro11X

aif-docs

Generate and maintain project documentation with a README and docs/ directory.

Community
Advanced