Documentation Gap Finder

Audit codebases and docs folders to surface undocumented or outdated areas.

9|1|Updated Mar 15, 2026

Search Tags:#documentation #onboarding #audit #dx #open-source #gap-analysis #documentation-quality

Ready to run

npx skills add https://github.com/Notysoty/openagentskills --skill documentation-gap-finder

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Documentation Gap Finder
Source: https://github.com/Notysoty/openagentskills/tree/main/skills/documentation-gap-finder
Command: npx skills add https://github.com/Notysoty/openagentskills --skill documentation-gap-finder

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit a codebase or docs folder to surface undocumented, outdated, or unclear areas, enabling faster remediation.

Core Features & Use Cases

Scans code and docs to identify missing docstrings, undocumented exports, README drift, stale setup steps, and undocumented public APIs.
Produces a prioritized gap list with concrete write-ups and suggested fixes, tailored for onboarding, OSS releases, and quarterly reviews.
Integrates with project audits to guide contributors and maintainers on what to document next.

Quick Start

Copy this file to .agents/skills/documentation-gap-finder/SKILL.md in your project root, then ask the agent to audit the target repository.

Frequently Asked Questions about Documentation Gap Finder

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

FAQPage Schema

How do I find missing docstrings and undocumented public APIs in my codebase?▼

To find missing docstrings and undocumented public APIs, audit your codebase to surface undocumented code areas and prioritize fixes. The scan identifies gaps in code exports, enabling faster remediation with actionable write-ups.

What is the best way to check for README drift and stale setup instructions?▼

Checking for README drift involves scanning your docs folder to detect outdated or unclear areas like stale setup instructions. A documentation audit compares your current setup steps against the codebase to produce a prioritized gap list.

Can I use a documentation audit for open-source onboarding and quarterly reviews?▼

Yes, you can use a documentation audit for open-source onboarding and quarterly reviews. It scans project files to identify undocumented exports and missing information, tailoring a prioritized gap list with suggested fixes for contributors and maintainers.

How do I audit a docs folder to identify undocumented exports?▼

You audit a docs folder by scanning the target repository to identify undocumented exports and missing docstrings. This process surfaces undocumented public APIs and outputs a prioritized gap list with concrete write-ups and suggested fixes.

Does the documentation gap analysis output suggested fixes for missing docstrings?▼

Yes, documentation gap analysis outputs suggested fixes for missing docstrings. It produces a prioritized gap list with concrete write-ups and recommendations, guiding contributors on exactly what to document next for faster remediation.