doc-gap-analyzer

Documentation gap analysis detects undocumented APIs and stale documentation by comparing public API endpoints and Python docstrings against existing pages. It flags files older than 90 days with recent code changes to produce prioritized gap reports.

Documentation coverage scanning compares public API endpoints and Python public functions against documentation pages and docstrings. It surfaces missing coverage by generating coverage percentages and prioritized targets from P0 to P3.

Pre-release audits identify broken examples referencing deprecated APIs and 404 links by checking link health and file modification timestamps. This process generates staleness reports and top-10 gap lists to ensure onboarding readiness.

Documentation gap detection works with repositories, documentation sites, and knowledge base audits by comparing Python public functions, docstrings, and knowledge graphs. It applies to onboarding, documentation sprints, and quarterly health reviews.

Post-feature doc updates are prioritized using gap classification reports that rank targets from P0 to P3. The analyzer compares recent code modifications against existing documentation timestamps to generate trend metrics for doc-to-code sync.

Documentation health reviews should be run during quarterly audits, pre-release checks, and post-feature updates. The process evaluates coverage metrics, staleness reports, and knowledge graph gaps to reduce onboarding friction and user confusion.