verify-docs

Fact-check repository documentation against code, configuration, and command outputs.

2|Updated Jul 11, 2024
One-click install
npx skills add https://github.com/nicograef/handbook --skill verify-docs-nicograef
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: verify-docs
Source: https://github.com/nicograef/handbook/tree/main/.claude/skills/verify-docs
Command: npx skills add https://github.com/nicograef/handbook --skill verify-docs-nicograef

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill solves the problem of documentation rot, where technical guides, runbooks, and READMEs drift away from the actual state of the code, configuration, and infrastructure they describe.

Core Features & Use Cases

  • Evidence-Based Verification: Validates claims against ground truth sources like code, config files, and read-only command output rather than relying on LLM recollection.
  • Consistency Auditing: Detects contradictions between different documents and identifies dead internal or external references.
  • Use Case: Use this after a major refactor to ensure that all setup guides and command examples in your handbook still match the updated repository structure and configuration keys.

Quick Start

Run the verify-docs skill to audit the entire repository documentation for accuracy against the current codebase.

Frequently Asked Questions about verify-docs

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

FAQPage Schema
How do I verify documentation accuracy against my codebase?

Documentation verification is performed by fact-checking repository docs against ground truth sources like code, config files, and command outputs to identify false claims, stale information, and broken references.

What is the best way to audit technical documentation for stale information?

A consistency audit detects stale information and contradictions between documents by validating claims against evidence-based ground truth sources rather than relying on memory, ensuring docs match the implementation.

How do I check for broken references in my repository documentation?

Checking for broken references involves auditing the committed corpus to identify dead internal and external links, ensuring technical guides and runbooks remain synchronized with the current infrastructure.

Can I use automated documentation auditing after a major code refactor?

Yes, automated documentation auditing is ideal after a major refactor to ensure setup guides and command examples still match the updated repository structure and configuration keys.

How does evidence-based documentation verification work?

Evidence-based verification works by validating documentation claims against read-only command outputs and configuration files to detect drift, ensuring technical writing remains synchronized with the technical implementation.