documentation-gap-finder

# Documentation Gap Finder ## What this skill does This skill directs the agent to audit a codebase or documentation directory and produce a comprehensive list of documentation gaps. It checks for missing docstrings, undocumented exports, README files that don't match the current code, stale setup instructions, and any public API surface that lacks documentation. The output is a prioritized gap list that tells you exactly what to write and in what order. Use this when preparing for a new developer joining the team, before an open-source launch, when onboarding is taking too long, or as part of a quarterly documentation review. ## How to use ### Claude Code / Cline Copy this file to `.agents/skills/documentation-gap-finder/SKILL.md` in your project root. Then ask: - *"Use the Documentation Gap Finder skill on the entire repo."* - *"Audit the documentation for `src/api/` using the Documentation Gap Finder skill."* - *"Use the Documentation Gap Finder skill — I want to know what a new developer would struggle to find."* ### Cursor Add the instructions below to your `.cursorrules` or paste them into the Cursor AI pane before asking for the audit. ### Codex Provide the directory tree and key files. Ask Codex to follow the instructions below to produce the gap report. ## The Prompt / Instructions for the Agent When asked to audit documentation, follow these steps: ### Step 1 — Establish scope Determine what to audit: - If given a specific directory, focus there - If ...