skills.rest
Heron11
Heron11COMMUNITY
Explore all skills by this author →
GitHub

docs-audit-and-refresh

Audit docs/ against repository code and tests for missing or stale content.

Updated Apr 8, 2026
Search Tags:#documentation#gap-analysis#developer-docs#repository-review#docs-audit#content-refresh
One-click install
npx skills add https://github.com/Heron11/otter-code --skill docs-audit-and-refresh-heron11
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-audit-and-refresh
Source: https://github.com/Heron11/otter-code/tree/main/.qwen/skills/docs-audit-and-refresh
Command: npx skills add https://github.com/Heron11/otter-code --skill docs-audit-and-refresh-heron11

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill keeps the docs/ tree aligned with the actual behavior shipping in the repository by identifying missing, incorrect, or stale documentation before users rely on it.

Core Features & Use Cases

  • Evidence-based gap detection: Compare docs/ to CLI commands, core packages, SDKs, and integrations using the code, tests, and schemas as ground truth before editing.
  • Impact-aware prioritization: Triage fixes toward broken onboarding flows, outdated defaults, missing surfaces, and high-visibility commands to maximize reader impact.
  • Structured refresh and validation: Update the minimal set of docs/ pages, adjust _meta.ts when needed, and summarize the audited surfaces plus concrete edits for the requester.

Quick Start

Ask the docs audit skill to review docs/ and refresh the affected pages using references/audit-checklist.md.

Frequently Asked Questions about docs-audit-and-refresh

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

FAQPage Schema
How do I audit developer docs for gaps and stale content in my repository?▼

Documentation drift occurs when code changes but the docs/ tree is not updated. An audit compares current code behavior and tests against existing pages to detect missing surfaces, incorrect defaults, and stale onboarding flows.

How do I refresh outdated documentation to match current code behavior?▼

To refresh outdated documentation, edit the minimal set of affected docs/ pages and adjust related _meta.ts files based on evidence from current repository tests and schemas. This ensures the docs tree matches actual shipping behavior.

Can I use a gap-analysis to update documentation for SDKs and integrations?▼

Yes, gap-analysis can update documentation for SDKs and integrations by referencing the audit checklist and comparing implementation areas against the existing docs/ tree to confirm all modifications are accurately reflected.

What is the best way to prioritize documentation fixes for maximum reader impact?▼

The best way to prioritize documentation fixes is impact-aware triage, targeting broken onboarding flows, outdated defaults, missing surfaces, and high-visibility CLI commands before applying edits to the docs/ directory.

Do I need to update _meta.ts files when refreshing repository documentation?▼

Yes, you need to update _meta.ts files when refreshing repository documentation if structural changes are required. The audit process confirms modifications appear in both the docs/ pages and their related _meta.ts files.

Related Skills

Explore More Content & Communication Skills→
compozycompozy
2.5k

cy-execute-task

Execute PRD tasks end-to-end with checklist validation and tracking updates.

Official
Advanced
I194I194
9

devex-review

Audits developer experience by scoring docs, onboarding flows, and CLI outputs live.

Community
Advanced
axel-kaliffaxel-kaliff

doc-drift

Detect documentation drift by comparing docstrings, markdown examples, and config references against code.

Community
Intermediate
captaindevvcaptaindevv

blog-audit

Assess blog content quality and technical health across markdown or HTML files.

Community
Advanced