How does this skill calculate documentation coverage?

It uses tools like Grep and Glob to compare the total number of documentable items, such as functions and classes, against those that actually contain valid docstrings or descriptive comments.

Can it identify outdated documentation?

Yes, part of the quality assessment involves checking the accuracy of documentation against the current code behavior to ensure examples and signatures are still valid.

Which programming languages are supported?

The skill includes specialized patterns for JavaScript, TypeScript, Python, and Go, but its general framework can be applied to most common programming languages.

What is included in the documentation report?

The report includes an executive summary, coverage percentages by category, quality scores across four dimensions, a list of critical gaps, and prioritized recommendations for improvement.

Documentation Health Analyst

Name: Documentation Health Analyst
Author: C0ntr0lledCha0s

byC0ntr0lledCha0s

•

학습 및 문서화

Evaluates codebase documentation for coverage, quality, and completeness while identifying critical gaps and generating health reports.

소개

The Analyzing Documentation skill empowers Claude to perform deep audits of code repositories to ensure documentation meets professional standards. It automatically calculates coverage metrics across functions, classes, and modules while assessing quality dimensions like accuracy and clarity. By utilizing language-specific patterns for JavaScript, Python, and Go, it identifies missing docstrings, outdated examples, and critical API gaps, ultimately generating structured reports that help teams prioritize and resolve documentation debt.

주요 기능

Automated coverage calculations for functions, classes, and modules
Language-specific scanning patterns for JavaScript, TypeScript, Python, and Go
Identification of undocumented public APIs and outdated usage examples
Multi-dimensional quality scoring for completeness, accuracy, and clarity
Comprehensive audit reports with executive summaries and gap analysis
1 GitHub stars

사용 사례

Ensuring all new public APIs are properly documented before a major release
Auditing a legacy codebase to identify and prioritize documentation debt
Generating documentation health metrics for architectural reviews or PR audits

소개

주요 기능

Automated coverage calculations for functions, classes, and modules
Language-specific scanning patterns for JavaScript, TypeScript, Python, and Go
Identification of undocumented public APIs and outdated usage examples
Multi-dimensional quality scoring for completeness, accuracy, and clarity
Comprehensive audit reports with executive summaries and gap analysis
1 GitHub stars

사용 사례

Ensuring all new public APIs are properly documented before a major release
Auditing a legacy codebase to identify and prioritize documentation debt
Generating documentation health metrics for architectural reviews or PR audits