docs-analyze

Cross-check documentation claims against source code and git history.

4|Updated Feb 9, 2021
One-click install
npx skills add https://github.com/breengles/poor-man-OS-setup --skill docs-analyze
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-analyze
Source: https://github.com/breengles/poor-man-OS-setup/tree/main/.claude/skills/docs-analyze
Command: npx skills add https://github.com/breengles/poor-man-OS-setup --skill docs-analyze

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams find misleading, incomplete, and outdated documentation before it wastes engineering effort or causes incorrect implementations.

Core Features & Use Cases

  • Doc accuracy verification: Checks each documentation claim against the corresponding source code and flags contradictions.
  • Completeness and coverage gaps: Identifies modules/features that exist in the codebase but have no documentation file.
  • Staleness detection: Compares recent commits for relevant code paths versus the last update time of each doc to quantify drift.

Quick Start

Run the docs-analyze Skill with the argument docs/ to generate a comprehensive quality report across all documentation files.

Frequently Asked Questions about docs-analyze

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

FAQPage Schema
How do I audit documentation for accuracy and staleness against my source code?

To audit documentation for accuracy and staleness, the Skill cross-checks doc claims against real source code and uses git log comparisons to quantify update drift, producing a prioritized quality report with per-file scorecards and recommended fixes.

What causes documentation staleness in a codebase?

Documentation staleness occurs when recent commits for relevant code paths outpace the last update time of each doc. This Skill detects drift by comparing git log changes against doc modifications to flag outdated files.

How do I find coverage gaps in my project documentation?

To find coverage gaps in your project documentation, this Skill inventories your docs/ files and identifies modules or features that exist in the codebase but have no corresponding documentation file.

Can I check documentation health for a specific component instead of the entire docs directory?

Yes, you can check documentation health for a specific file, a named component, or the entire docs directory. The Skill scopes its source code cross-checking and git log change tracking to the target you specify.

Does the documentation quality report include recommended fixes?

Yes, the documentation quality report includes recommended fixes. It provides prioritized per-file scorecards that flag contradictions with source code, coverage gaps, and staleness drift to guide corrections.