doc-gap-analyzer

Community

Identify and prioritize documentation gaps

Authorkmshihab7878
Version1.0.0
Installs0

System Documentation

What problem does it solve?

The Doc Gap Analyzer finds undocumented APIs, stale documentation, broken examples, and knowledge graph gaps so documentation teams can prioritize work that reduces onboarding friction and user confusion.

Core Features & Use Cases

  • Coverage scanning: Compares public API endpoints and Python public functions against documentation pages and docstrings to surface missing coverage.
  • Staleness detection: Flags docs older than 90 days that have accompanying recent code changes, broken examples referencing deprecated APIs, and 404 links.
  • Gap classification & reporting: Produces prioritized targets (P0–P3), top-10 gap lists, coverage percentages, staleness reports, and trend metrics for doc-to-code sync.
  • Use cases: Pre-release audits, post-feature doc updates, quarterly documentation health reviews, and onboarding readiness checks.

Quick Start

Run a full coverage scan to identify undocumented APIs, stale pages, missing examples, and knowledge graph gaps and generate a prioritized gap report.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-gap-analyzer
Download link: https://github.com/kmshihab7878/claude-code-setup/archive/main.zip#doc-gap-analyzer

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.