qa-docs-coverage

Audit codebases to identify documentation gaps and generate coverage reports.

73|16|Updated Nov 14, 2025

Search Tags:#templates #documentation #audit #docs #coverage

Ready to run

npx skills add https://github.com/vasilyu1983/AI-Agents-public --skill qa-docs-coverage

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: qa-docs-coverage
Source: https://github.com/vasilyu1983/AI-Agents-public/tree/main/frameworks/claude-code-kit/framework/skills/qa-docs-coverage
Command: npx skills add https://github.com/vasilyu1983/AI-Agents-public --skill qa-docs-coverage

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Discovers missing documentation areas and generates coverage reports to improve docs quality.

Core Features & Use Cases

Discovery patterns: API/docs/events/schema coverage.
Gap analysis: Prioritized backlog for missing docs.
Automated generation: Create docs from templates.

Quick Start

Run a docs-coverage audit on a new service and generate a backlog of missing docs.

Frequently Asked Questions about qa-docs-coverage

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

FAQPage Schema

How do I audit a codebase for documentation gaps?▼

Documentation gap audits scan APIs, services, events, database schemas, and configurations to identify what's missing. This Skill discovers coverage gaps across these areas, generates prioritized reports of missing documentation, and creates artifacts for remediation.

Can I automate documentation generation from templates?▼

Yes. This Skill applies templates to automatically generate missing documentation based on audit findings. It produces documentation artifacts alongside coverage reports, reducing manual writing effort.

What does a documentation coverage report include?▼

Coverage reports map documented vs. undocumented components across APIs, services, events, schemas, and configurations. Reports prioritize gaps and generate backlog items, showing which areas need documentation work first.

How does phase-based auditing improve documentation discovery?▼

Phase-based audits systematically scan distinct layers—APIs, schemas, configurations, events—in sequence. This staged approach ensures comprehensive coverage and produces structured inventories that prioritize gaps by functional area.

Can documentation audits integrate into CI/CD pipelines?▼

Yes. This Skill supports CI/CD integration to run audits automatically during builds. Automated audits catch documentation gaps early and generate backlog items without manual intervention.

What's the difference between discovery patterns and gap analysis?▼

Discovery patterns identify which components exist across APIs, docs, events, and schemas. Gap analysis compares that inventory against documentation to surface what's missing and prioritize remediation efforts.