docs-coverage

Docs coverage

A skill for auditing whether a design system's documentation surface keeps pace with its components. It measures the code (the source of truth for what exists) against each documentation surface and reports three things: coverage gaps (components with no documentation), staleness (documentation that predates the component's last code change), and orphaned docs (pages for components that no longer exist). Produces a severity-rated finding table with per-signal confidence labelling.

Context

Code is the source of truth for what components exist; the documentation surface is measured against it. A component in code with no docs is a coverage gap; a page for a deleted component is an orphan; a page older than the component's last change is a staleness risk.

This skill is built to work with no integration at all: a components directory plus a Storybook build plus git history answer coverage and staleness for most teams. Hosted platforms (Zeroheight, Supernova, custom docs sites) are optional layers that light up when configured — never prerequisites. The audit never blocks on an integration; it logs what is unavailable and proceeds with what it can reach.

The hard part is trust. Coverage is a join between two lists — components in code and entries in the doc surface — and the join is only as reliable as the key that links them. Every coverage finding carries a confidence tier so a fuzzy guess is never presented as a fact. See documentation-coverage.md for the full model.

---

Configuration

Before producing output, check for a .ds-ops-config.yml file in the project root. If present, load:

• system.framework — affects how component files are discovered (e.g. .tsx / .vue / .twig)
• severity.* — severity-rating overrides, applied the same way the other audit skills apply them
• integrations.storybook.static_path — local Storybook build directory (e.g. storybook-static); the preferred source
• integrations.storybook.url — published Storybook URL for pulling /index.json when no local build exists
• integrations.documentation — optional hosted platform: platform, url, api_key_env, plus styleguide_id (Zeroheight) or design_system_id (Supernova)
• integrations.github — if enabled, used to read change history when the audit runs outside a local clone
• docs_coverage.staleness_threshold_days — grace window before a doc is flagged stale (default 90)
• recurring.* — if this is a recurring run, load the previous report for trend comparison