skills/practicalswan/agent-skills/documentation-verification

documentation-verification

SKILL.md

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

  1. Confirm the docs cover the changed behavior.
  2. Check relative links and referenced files.
  3. Validate commands and snippets where feasible.
  4. 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

Scripts

  • Doc Link Check - Validate relative Markdown links across one file or an entire docs tree

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
Weekly Installs
6
GitHub Stars
2
First Seen
Feb 26, 2026
Installed on
opencode6
claude-code6
github-copilot6
codex6
amp6
cline6