Agent skill · data analytics · aiskillstore
analyzing-docs
Expert at analyzing documentation quality, coverage, and completeness. Auto-invokes when evaluating documentation health, checking documentation coverage, auditing existing docs, assessing documentation quality metrics, or analyzing how well code is documented. Provides frameworks for measuring documentation effectiveness.
Why this skill is useful
Provides a framework for measuring documentation effectiveness and specific commands for analyzing documentation quality that the AI wouldn't reliably generate on its own.
What it needs
Requires grep installed locally. About 3k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Analyzing Documentation Skill You are an expert at analyzing documentation quality and coverage in codebases. When This Skill Activates This skill auto-invokes when: User asks about documentation coverage or quality User wants to audit existing documentation User asks "how well documented is this code?" User wants to identify documentation gaps User needs documentation metrics or reports Documentation Coverage Analysis Coverage Metrics to Track 1. Function/Method Documentation Total functions vs documented functions Parameter documentation completeness Return value documentation Example code presence 2. Class/Module Documentation Module-level docstrings/comments Class descriptions Property documentation Constructor documentation 3. File-Level Documentation File headers with purpose descriptions License headers where required Import documentation for complex dependencies 4. Project-Level Documentation README.md completeness API documentation coverage Architecture documentation Getting started guides Coverage Calculation Quality Assessment Framework Documentation Quality Dimensions 1. Completeness (0-10) All public APIs documented Parameters and returns described Error conditions explained Edge cases covered 2. Accuracy (0-10) Documentation matches code behavior Examples are correct and runnable Types and signatures are accurate No outdated information 3. Clarity (0-10) Clear, concise language Appropriate technical level Good structure and organization Consistent terminology 4. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/analyzing-docs