← ClaudeAtlas

doctruth-auditlisted

Runs the three docs-truth checks in order (links, CLI flags and environment variables, code snippets and versions), merges the findings into one prioritised report where broken first-run instructions rank highest, and proposes a minimal patch per finding. Use when the user says "audit my docs", "does my README lie", "is the quick start still correct", "check the docs against the code", "full docs check before the release", or "what in my documentation is out of date". This skill has no script of its own; it calls the scripts of its three sibling skills.
vivekbhange-hub/docs-truth-skill · ★ 0 · Data & Documents · score 75
Install: claude install-skill vivekbhange-hub/docs-truth-skill
# doctruth-audit: one report, worst problem first The three checkers each answer one question. This skill runs all three, puts their findings on one scale, and ranks by what a first-time reader would hit first. It calls the scripts that live in the sibling skill folders, so the pack must be installed whole: `doctruth-links`, `doctruth-cli` and `doctruth-snippets`. ## Inputs - A project folder with docs and code. - Optional: `--online` for external links (only with the user's agreement, see `doctruth-links`). - Commands below say `python3`; on Windows use `python` (or `py -3`). ## Outputs - `docs-truth/audit.md`: a ranked table, a patch per finding, and what could not be checked. - `docs-truth/*.json`: the raw output of each script, so the report can be regenerated. - A summary for the user: how many findings, how many block a first run, what to fix first. ## Steps 1. **Confirm permission.** Audit and edit docs only in a repository the user owns or is authorized to change. The scripts read files and never execute documentation. 2. **Run the three scripts in order**, saving JSON, from the project root. ``` python3 "${CLAUDE_SKILL_DIR}/../doctruth-links/link_check.py" . --json > docs-truth/links.json python3 "${CLAUDE_SKILL_DIR}/../doctruth-cli/cli_drift.py" . --json > docs-truth/cli.json python3 "${CLAUDE_SKILL_DIR}/../doctruth-snippets/snippet_check.py" . --json > docs-truth/snippets.json ``` Create `docs-truth/` first. Exit code 2 means bad input