skills.rest
NodeJSmith
NodeJSmithCOMMUNITY
Explore all skills by this author →
GitHub

doc-coverage-review

Identify user-facing codebase features missing from documentation.

77|5|Updated Sep 1, 2025
Search Tags:#code review#documentation#audit#framework#gap analysis#coverage
One-click install
npx skills add https://github.com/NodeJSmith/hassette --skill doc-coverage-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-coverage-review
Source: https://github.com/NodeJSmith/hassette/tree/main/.claude/skills/doc-coverage-review
Command: npx skills add https://github.com/NodeJSmith/hassette --skill doc-coverage-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you discover user-facing features in a codebase that are missing from the documentation, so teams can close coverage gaps before users have to read the source.

Core Features & Use Cases

  • Area-by-area inventory: Breaks a project into major source areas and lists the public methods, flags, config keys, exceptions, and behaviors that users can actually encounter.
  • Coverage triage: Separates fully explained features from reference-only mentions and truly undocumented capabilities.
  • Documentation gap reporting: Produces concise, actionable findings with source locations, search evidence, and suggested doc homes.
  • Use Case: A maintainer wants to know whether a framework’s CLI, config, and runtime APIs are all discoverable from the docs before a release.

Quick Start

Ask for a documentation coverage review of the repository or a specific area such as CLI, config, API, or web routes.

Frequently Asked Questions about doc-coverage-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find undocumented features in a codebase before a release?▼

Documentation coverage review identifies undocumented features by scanning framework areas like API, config, and CLI, then verifying whether each public capability is fully covered, reference-only, or missing from the docs.

What is a documentation gap analysis for software frameworks?▼

Documentation gap analysis for frameworks separates fully explained features from reference-only mentions and truly undocumented capabilities, producing actionable findings with source locations and suggested doc homes.

How do I audit codebase coverage for CLI and config documentation?▼

Audit codebase coverage by requesting an area-specific review of the repository, which scans CLI, config, API, and web routes to list public methods, flags, and behaviors that users can encounter.

Can I check documentation coverage for specific framework areas like scheduler and state access?▼

Yes, documentation coverage checks can target specific framework areas such as scheduler, state access, app lifecycle, exceptions, and test utilities to verify if public capabilities are discoverable from the docs.

What's the best way to triage reference-only mentions in technical documentation?▼

The best way to triage reference-only mentions is to run a coverage review that categorizes each public capability as fully explained, reference-only, or undocumented, then reports actionable gaps with search evidence.

Related Skills

Explore More Software Engineering Skills→
ano4lano4l

characterization-test-generator

Generate characterization tests that document current code behavior before refactoring.

Community
Advanced
FoundationForgeFoundationForge

stakeholder-update

Generate audience-tailored stakeholder updates from accomplishments, blockers, and decisions.

Official
Intermediate
namanchopranamanchopra
5

plan-founder-review

Review technical plans for completeness, risk coverage, and codebase alignment.

Community
Advanced
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate