doc-verifier

Validate project documentation by running code examples and checking links against source files.

5|Updated Apr 8, 2026
One-click install
npx skills add https://github.com/JansenAnalytics/claudex --skill doc-verifier
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-verifier
Source: https://github.com/JansenAnalytics/claudex/tree/main/skills/doc-verifier
Command: npx skills add https://github.com/JansenAnalytics/claudex --skill doc-verifier

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Documentation rot undermines user trust by letting guides, API docs, and examples become stale or incorrect; this Skill provides automated checks to ensure docs stay accurate, complete, and usable.

Core Features & Use Cases

  • Validates that code examples actually run and match expectations.
  • Verifies links, anchors, and CLI/API alignment across documentation.
  • Produces a health-focused report highlighting gaps and recommended improvements for docs teams.

Quick Start

Run doc-verifier on your project directory to audit its documentation and produce a health report.

Frequently Asked Questions about doc-verifier

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check for broken links and stale code examples in my project documentation?

To validate API documentation accuracy against OpenAPI specs, use automated cross-checking tools that compare documented endpoints and parameters against the actual spec file, highlighting stale content and incomplete sections in a structured health report.

How do I automate documentation validation across codebases and CLI tools?

Automating documentation validation across codebases and CLI tools involves running deterministic evaluation scripts that read docs, execute example scripts, compare outputs against reality, and generate structured reports highlighting gaps and recommended improvements.

Does documentation validation work with OpenAPI specs and CLI help alignment?

Yes, documentation validation works with OpenAPI specs and CLI help by cross-checking the documented commands and API endpoints against the actual source files and runtime behavior to ensure complete alignment and accuracy.

What is documentation rot and how do I prevent it in software docs?

Documentation rot is the process where guides and API docs become stale or incorrect over time; it is prevented by running automated validation checks that cross-reference code examples, links, and APIs against the actual source code.

What are the limitations of automated documentation validation?

Limitations of automated documentation validation include relying on deterministic execution of sample scripts, meaning it may not catch subjective inaccuracies, poorly formatted non-standard markup, or complex runtime states not covered by static cross-checking.