← ClaudeAtlas

doctruth-writerlisted

A procedure for writing documentation that stays true: derive option tables and version numbers from the code instead of typing them, prefer snippets that can be checked, keep the quick start under five steps, add a docs check to CI, and record the date and version each claim was last verified. Use when the user says "write a README that will not go stale", "document this CLI", "how do I keep the docs in sync with the code", "add a docs check to CI", "write the quick start", or "make the install instructions reliable". It has no script; it uses the checkers of the sibling skills as the proof.
vivekbhange-hub/docs-truth-skill · ★ 0 · AI & Automation · score 75
Install: claude install-skill vivekbhange-hub/docs-truth-skill
# doctruth-writer: docs that survive the next release Docs go stale because a person has to remember to update them. This procedure removes the remembering: generate what can be generated, check what can be checked, and date the rest. ## Inputs - The thing to document: a CLI, a library, an install path, a whole README. - Access to the code, so every claim can be traced to a line. - Commands below say `python3`; on Windows use `python` (or `py -3`). ## Outputs - The doc, written so that each factual claim has a source: the code, a command, or a dated note. - A generated options table, when the project has a CLI. - A CI step that runs the docs checks, and a short "last verified" line where claims cannot be generated. ## Steps 1. **Confirm permission.** Write and edit docs only in a repository the user owns or is authorized to change. Do not copy text from other projects' docs. 2. **Find the facts in the code before writing a sentence.** Flags and defaults, environment variables, command names, supported versions, install names. Read them; do not recall them. 3. **Generate, do not transcribe.** For a CLI, build the options table from the code: ``` python3 "${CLAUDE_SKILL_DIR}/../doctruth-cli/cli_drift.py" . --table-only ``` Paste the output between two comment markers (`<!-- options:start -->` and `<!-- options:end -->`) so the next run replaces exactly that block. Read the version from the manifest (`pyproject.toml`, `package.json`) rather tha