Documentation Verification
Use this skill when a docs change needs evidence, not just a writing pass.
Activation Conditions
- Reviewing docs before merge or release
- Checking README, setup, or config accuracy
- Verifying local links, commands, and code samples
- Confirming docs changed alongside user-facing behavior
Verification Workflow
- Confirm the docs cover the changed behavior.
- Check relative links and referenced files.
- Validate commands and snippets where feasible.
- Report missing coverage and stale claims explicitly.
Review Checklist
- Public behavior changes are documented
- Local links resolve
- Examples and commands still make sense
- Setup steps reflect current tool versions
- README and CHANGELOG were updated when required
References & Resources
Documentation
- Validation Procedures - Practical checks for links, examples, config, and coverage
Scripts
- Doc Link Check - Validate relative Markdown links across one file or an entire docs tree
Cross-Client Portability
This skill is written to stay usable across GitHub Copilot, Claude Code, Codex, and Gemini CLI.
- GitHub Copilot: keep the folder in a Copilot-visible skill or plugin path, or wrap the workflow as project instructions if the host does not support portable skill folders directly.
- Claude Code: keep the folder in a local skills directory or a compatible plugin or marketplace source.
- Codex: install or sync the folder into
$CODEX_HOME/skills/<skill-name>and restart Codex after major changes. - Gemini CLI: this repository generates a project command named
/skills:documentation-verificationfrom this skill. Rebuild commands withpython scripts/export-gemini-skill.py documentation-verificationand then run/commands reloadinside Gemini CLI.
MCP Availability And Fallback
No dedicated MCP server is required for the normal workflow in this skill.
- If the current host lacks an equivalent tool surface, use the bundled scripts, standard shell or editor tooling, and the manual workflow already described in this skill.
- Treat local verification as the fallback evidence path before closing the task.
Related Skills
| Skill | Relationship |
|---|---|
| documentation-quality | Quality standards to verify against |
| documentation-authoring | Verify authored docs before publishing |
| code-examples-sync | Validate code examples are current and working |