Doc Accuracy Review

Verify documentation claims against current source code with evidence-backed findings.

77|5|Updated Sep 1, 2025

Search Tags:#drift detection #documentation review #code verification #source of truth #cli docs #api accuracy

Ready to run

npx skills add https://github.com/NodeJSmith/hassette --skill doc-accuracy-review

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Doc Accuracy Review
Source: https://github.com/NodeJSmith/hassette/tree/main/.claude/skills/doc-accuracy-review
Command: npx skills add https://github.com/NodeJSmith/hassette --skill doc-accuracy-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps prevent documentation drift by checking whether a documentation page matches the current source code, so users can trust that APIs, defaults, flags, and behaviors are still correct.

Core Features & Use Cases

Page-by-Page Verification: Reviews one documentation page or an entire section against the corresponding code paths.
Claim Checking: Validates checkable statements such as API signatures, default values, behaviors, exceptions, config keys, CLI flags, import paths, version requirements, and file paths.
Evidence-Based Findings: Produces structured findings with exact doc quotes, code citations, severity, and suggested fixes.
Use Case: A maintainer updates code in src/hassette/ and wants to confirm the docs still describe the real runtime behavior before shipping a release.

Quick Start

Ask the skill to verify a specific documentation page or section against the current source code in the repository.

Frequently Asked Questions about Doc Accuracy Review

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

FAQPage Schema

How do I check if my API documentation matches the current source code?▼

To check if API documentation matches source code, you verify checkable claims like API signatures, default values, and import paths against the actual implementation. This process flags incorrect, outdated, or unverifiable statements with evidence-backed findings and suggested fixes.

How do I verify CLI flag documentation against my repository's code paths?▼

You verify CLI flag documentation by inspecting the corresponding code paths in your repository and validating checkable statements like flag names, default values, and behaviors. The review produces structured findings with severity levels and suggested fixes for any mismatched claims.

Can I review an entire configuration guide section against the source code at once?▼

Yes, you can review an entire configuration guide section against the source code at once. The page-by-page verification process applies to API references, CLI pages, configuration guides, and cross-cutting docs to identify statements that have drifted after code changes.

What is the best way to find outdated documentation claims before a release?▼

The best way to find outdated documentation claims before a release is to run a source-code inspection that validates checkable statements like behaviors, exceptions, and config keys. It generates structured findings with exact doc quotes, code citations, and severity levels for any mismatches.

What types of documentation claims can be verified against source code?▼

Documentation claims that can be verified against source code include API signatures, default values, behaviors, exceptions, config keys, CLI flags, import paths, version requirements, and file paths. The verification process checks these checkable statements and flags any that are unverifiable or outdated.