analyzing-docs

Documentation coverage calculates the percentage of documented items (functions, classes, files) against total items using the formula (Documented Items / Total Items) × 100. This Skill analyzes your codebase with language-specific patterns for JavaScript/TypeScript, Python, and Go to detect undocumented elements and report coverage metrics at function, class, file, and project levels.

This Skill assesses documentation across four quality dimensions: completeness, accuracy, clarity, and usefulness. It generates a Quality Score alongside coverage percentages, enabling you to identify not just gaps in documentation but also weaknesses in existing documentation quality.

Yes. This Skill implements language-specific detection patterns for JavaScript/TypeScript, Python, and Go using grep-based searches to identify undocumented functions, methods, classes, and modules, making it suitable for audits across these tech stacks.

This Skill outputs structured analysis results including coverage metrics, quality scores, and documentation gaps with improvement suggestions. Results are formatted for dashboards and RAG pipelines, giving you both human-readable reports and machine-consumable data for further processing.

Run a docs health check with this Skill to scan your entire codebase systematically. It detects undocumented items at multiple levels—function/method, class/module, and file—using language-specific patterns, then surfaces gaps with coverage and quality metrics in a single generated report.