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 87 stars 19 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
65
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
10 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