About

Imported from practicalswan/agent-skills (documentation-verification/SKILL.md). Install upstream with npx skills add practicalswan/agent-skills --skill documentation-verification. Copyright stays with the author.

Documentation Verification

Name: documentation-verification
Author: practicalswan

Use this skill when a docs change needs evidence, not just a writing pass.

Leverage native parallel subagent dispatch and 200k+ context windows where available.

Activation Conditions

Use symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.

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.

Documentation Stack Reference

Inherit the shared stack from documentation-patterns: source-of-truth discovery, audience framing, structure selection, verification, and freshness checks. Keep this skill focused on final evidence checks instead of restating the full stack.

Anti-Patterns

Writing for the author instead of the reader: It bakes in unstated context and leaves the actual audience unsure what to do next.
Skipping concrete examples or commands: Abstract guidance is easy to approve and hard to apply correctly.
Letting links, screenshots, or versions drift: Polished formatting does not help if the instructions are no longer true.

Verification Protocol

Before claiming "skill applied successfully":

Pass/fail: The Documentation Verification output identifies audience, purpose, source of truth, and freshness requirements.
Pass/fail: Shared documentation-stack guidance is referenced instead of duplicating another documentation skill.
Pass/fail: Claims, links, commands, examples, and screenshots are verified or explicitly marked unverified.
Pressure-test scenario: Apply the skill to a doc request with a stale command, missing owner, and conflicting audience.
Success metric: Zero undocumented assumptions; every reader-facing claim is sourced or scoped.

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, and Codex.

GitHub Copilot: keep the folder in a Copilot-visible skill path or wrap the workflow in project instructions when folder discovery is unavailable.
Claude Code: keep the folder in a local skills directory or a compatible plugin source.
Codex: install or sync the folder into $CODEX_HOME/skills/documentation-verification and restart Codex after major changes.

MCP Availability And Fallback

Preferred MCP Server: None required

Fallback prompt: "Use the Documentation Verification skill without MCP. Rely on the local SKILL.md, bundled references or scripts, and manual verification. Show the exact commands, evidence, and final checks you used before concluding."
If the current host does not expose a matching server, use the bundled references, scripts, native toolchain, and manual workflow already described in this skill.
Treat direct local verification, rendered output, logs, tests, or screenshots as the fallback evidence path before completion.

Related Skills

documentation-authoring: Use it when the workflow also needs drafting structured technical or product documents.
documentation-patterns: Use it when the workflow also needs reusable documentation structures and templates.
documentation-quality: Use it when the workflow also needs documentation review standards and quality gates.
notion-docs: Use it when the workflow also needs Notion page and database publishing workflows.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/practicalswan-agent-skills-documentation-verification/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

practicalswan-agent-skills-documentation-verification.ocm.jsonjson

{
  "ocm": "1",
  "id": "practicalswan-agent-skills-documentation-verification",
  "kind": "skill",
  "name": "documentation-verification",
  "description": "Validate documentation before merging - check completeness, broken links, code example accuracy, and factual correctness. Use when reviewing docs for quality gates or running pre-merge doc validation.",
  "publisher": "practicalswan",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "documentation",
      "verification",
      "docs",
      "writing",
      "quality",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Validate documentation before merging - check completeness, broken links, code example accuracy, and factual correctness. Use when reviewing docs for quality gates or running pre-merge doc validation."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/practicalswan/agent-skills",
      "path": "documentation-verification/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/practicalswan/agent-skills/blob/HEAD/documentation-verification/SKILL.md",
      "key": "practicalswan/agent-skills/documentation-verification/SKILL.md"
    }
  },
  "instructions": "# Documentation Verification\n\nUse this skill when a docs change needs evidence, not just a writing pass.\n\n- Leverage native parallel subagent dispatch and 200k+ context windows where available.\n\n\n## Activation Conditions\n\nUse symptom -> action triggers: when one matches, apply this skill and verify with the protocol below.\n\n- Reviewing docs before merge or release\n- Checking README, setup, or config accuracy\n- Verifying local links, commands, and code samples\n- Confirming docs changed alongside user-facing behavior\n\n## Verification Workflow\n\n1. Confirm the docs cover the changed behavior.\n2. C",
  "cost": {
    "context_tokens": 1109
  }
}

Fetch it by URL: GET /api/v1/registry/practicalswan-agent-skills-documentation-verification/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.