Rigorous quality gate for documentation before merge or publish. Verifies code examples run, links resolve, APIs match implementation, and all sections are complete. Use when auditing docs, reviewing documentation PRs, or when "verify", "quality gate", "docs audit", or "check examples" is mentioned.
View on GitHubinternal/skills/docs-check/SKILL.md
February 1, 2026
Select agents to install to:
npx add-skill https://github.com/outfitter-dev/agents-internal/blob/main/internal/skills/docs-check/SKILL.md -a claude-code --skill docs-checkInstallation paths:
.claude/skills/docs-check/# Documentation Check Rigorous quality gate for documentation. Focused on correctness, completeness, and comprehensiveness — not just voice and style. ## Usage ``` /docs-check [focus] ``` ### Examples ``` /docs-check # Full quality gate /docs-check focus on code examples # Verify examples run /docs-check check API completeness # Parameter coverage /docs-check are all links valid? # Link check /docs-check just the Quick Start # Section-specific ``` ## Arguments **Focus**: $ARGUMENTS Use arguments to narrow the scope: | Argument Type | Example | Behavior | |---------------|---------|----------| | Section name | `just the Quick Start` | Audit only that section | | Quality dimension | `focus on correctness` | Prioritize that checklist | | Specific question | `are the code examples runnable?` | Answer directly with evidence | | None provided | (empty) | Run full checklist across all dimensions | ## Verification Checklist Work through each dimension. For each item, document: PASS/FAIL + evidence. ### Correctness (accuracy) | Check | How to Verify | |-------|---------------| | Code examples run | Extract and execute each example. Report errors verbatim. | | API signatures match | Compare documented signatures against source code. | | Links resolve | Check each link target exists (relative paths, anchors, URLs). | | Technical claims accurate | Cross-reference against implementation or authoritative source. | | Versions current | Verify version numbers match package.json, Cargo.toml, etc. | ### Completeness (nothing missing) | Check | How to Verify | |-------|---------------| | Required sections present | Compare against applicable template (README, API ref, guide). | | Parameters documented | Each param has: type, purpose, constraints, default value. | | Error scenarios covered | Document what happens when things go wrong. | | Edge cases addressed | Empty inputs, nulls, boundaries, concurrent access. |