audit-documentation

Audit documentation against recently shipped features and file GitHub issues for gaps.

22|Updated Apr 1, 2026
One-click install
npx skills add https://github.com/handarbeit/fabrik --skill audit-documentation-handarbeit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-documentation
Source: https://github.com/handarbeit/fabrik/tree/main/.claude/skills/audit-documentation
Command: npx skills add https://github.com/handarbeit/fabrik --skill audit-documentation-handarbeit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Recently shipped features often go undocumented, causing documentation drift. This Skill compares closed GitHub issues against USER_GUIDE.md, README.md, and docs/index.md to find gaps, files new documentation issues, and closes stale ones whose gaps are now covered. ## Core Features & Use Cases - Gap Detection: Scans issues closed in the last 30 days or referenced in commits since a git tag, then compares each feature against the three documentation files. - Issue Management: Files new gap issues labeled documentation and fabrik:yolo, adds them to the Fabrik PM project board with Specify status, and closes existing documentation issues whose gaps are now covered. - Deduplication & Filtering: Excludes documentation-labeled and infrastructure-only issues, and avoids filing duplicates of already-open gap issues. - Use Case: After shipping a release, run the audit with --since v0.0.20 to verify every user-facing change in that release is documented, and automatically file issues for anything missing. ## Quick Start Run the audit-documentation skill to scan issues closed in the last 30 days and file GitHub issues for any undocumented features.

Frequently Asked Questions about audit-documentation

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

FAQPage Schema
How do I audit documentation for undocumented features on GitHub?

Run the audit with no arguments to scan issues closed in the last 30 days, or pass --since with a git tag to scan issues referenced in commits since that tag. The skill compares each shipped feature against USER_GUIDE.md, README.md, and docs/index.md and files gap issues.

How do I find documentation gaps after a release?

Use tag-based mode with --since v0.0.20 to extract issue numbers from commit messages and merged PR bodies containing Closes #NNN references. The skill then checks each feature against the documentation files and reports gaps.

Does the audit close existing documentation issues automatically?

Yes, but conservatively. It closes an open documentation issue only when the current docs clearly and completely cover the described gap. Partial coverage leaves the issue open to avoid losing track of unfinished documentation work.

What are the limitations of tag-based documentation scanning?

Tag-based mode may miss issues whose PRs used Fixes or bare URLs instead of Closes #NNN references. Date-based mode can also hit GitHub API rate limits on repositories with hundreds of closed issues.

Which issues are excluded from the documentation audit?

Issues labeled documentation are excluded to avoid recursive analysis, and infrastructure-only issues such as CI fixes, dependency bumps, and internal refactors with no user-facing behavior change are filtered out.