qa-docs-coverage

Solid

Audit and enforce doc quality. Use when checking coverage, freshness, runbook validity, or cleaning stale/duplicate markdown after LLM edits.

AI & Automation 80 stars 17 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
64
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# QA Docs Coverage (Jan 2026) - Discovery, Freshness, and Runbook Quality ## Modern Best Practices (January 2026) - **Docs as QA**: Treat docs as production artifacts with owners, review cadence, and CI quality gates (links/style/contracts/freshness) - **Contract-first**: Validate OpenAPI/AsyncAPI/JSON Schema in CI; use coverage tools (Swagger Coverage / OpenAPI Coverage) to detect gaps - **Runbook testability**: Every runbook must be executable in staging; validate with synthetic tests and incident exercises - **Automation + observability**: Track coverage %, freshness, and drift via CI dashboards; prevent regressions via PR checklists This skill provides operational workflows for auditing existing codebases, identifying documentation gaps, and systematically generating missing documentation. It complements [docs-codebase](../docs-codebase/SKILL.md) by providing the **discovery and analysis** layer. **Key Principle**: Templates exist in docs-codebase. This skill tells you **what** to document and **how to find** undocumented components. Core references: [Diataxis](https://diataxis.fr/) (doc structure), [OpenAPI](https://spec.openapis.org/oas/latest.html) (REST), [AsyncAPI](https://www.asyncapi.com/) (events). ## When to use - Auditing an existing repo for missing/outdated documentation - Adding documentation quality gates (lint/link checks/contracts/freshness) to CI/CD - Validating runbooks for incident readiness (MTTR reduction) ## When to avoid - Writing new docum...

Details

Author
vasilyu1983
Repository
vasilyu1983/AI-Agents-public
Created
9 months ago
Last Updated
1 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

doc-accuracy

Multi-phase documentation verification treating code as source of truth. Use when you say "check documentation accuracy", "verify code examples compile", "audit docs vs code", "check doc consistency", or "run doc-accuracy". Use for pre-release doc audits and checking behavioral claims. Do NOT use for broad codebase analysis (use analyze) or fixing markdown fence syntax (use fix-markdown-fences).

42 Updated today
rjmurillo
AI & Automation Listed

docs-architect

Audit the information architecture of a documentation set against what developers and AI assistants actually need, and report what is missing. Maps existing pages to a reference model, finds gaps and orphans, checks whether code examples run, and evaluates machine readability including llms.txt and clean-markdown access. Optionally drafts the missing quickstart. Works on a docs directory, a documentation site, or a repository README. Use when asked to review or restructure documentation, to find documentation gaps, to make docs AI-readable or agent-readable, or when docs exist but developers still cannot find what they need.

0 Updated 2 days ago
agentrel
AI & Automation Listed

audit

Audit existing project documentation for quality, completeness, consistency, and code alignment. Scans docs against the actual codebase to find stale references, missing coverage, internal contradictions, and quality issues. Generates a structured findings report with severity levels and actionable fix recommendations. Works on any project with a docs/ directory.

5 Updated 1 months ago
tercel