القائمة
Audits a codebase or docs folder and lists everything that is undocumented, outdated, or unclear.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Runs a systematic checklist review on any code diff or file, covering correctness, security, performance, and readability.
Writes a high-quality CLAUDE.md, .cursorrules, or .windsurfrules file that gives a coding agent the right project context, conventions, and constraints to work effectively.
Designs an eval suite for an LLM agent or pipeline including success metrics, trajectory scoring, LLM-as-judge setup, and regression test cases.
Designs a hybrid retrieval pipeline combining dense vector search and BM25 sparse search with reciprocal rank fusion, and explains when to use each configuration.
Converts a workflow description into a LangGraph node/edge graph with typed state, conditional routing, and human-in-the-loop checkpoints.
Audits an AI application for unnecessary token spend and recommends prompt caching, model routing, and token reduction techniques to cut costs.
| name | Documentation Gap Finder |
| description | Audits a codebase or docs folder and lists everything that is undocumented, outdated, or unclear. |
| category | productivity |
| tags | ["documentation","audit","dx","technical-writing"] |
| author | simplyutils |
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.
Copy this file to .agents/skills/documentation-gap-finder/SKILL.md in your project root.
Then ask:
src/api/ using the Documentation Gap Finder skill."Add the instructions below to your .cursorrules or paste them into the Cursor AI pane before asking for the audit.
Provide the directory tree and key files. Ask Codex to follow the instructions below to produce the gap report.
When asked to audit documentation, follow these steps:
Determine what to audit:
docs/ or wiki/ folder, README.md, all public API surfaces, and configuration filesREADME / Project-level docs
README.md exist at the project root?package.json, Dockerfile, or equivalent.Code-level documentation
API documentation
Architecture documentation
Operational documentation
Onboarding documentation
For documentation that exists, check for staleness signals:
Score each gap:
## Documentation Gap Report — [Project / Directory]
### Summary
- Critical gaps: N
- High-priority gaps: N
- Medium-priority gaps: N
- Low-priority gaps: N
---
### Critical Gaps
#### 1. [Gap title]
- **Type**: [Missing / Outdated / Unclear]
- **Location**: [Where it should live, e.g., `README.md` setup section]
- **Impact**: [Who is affected and how]
- **What to write**: [Specific description of what the documentation should say]
### High-Priority Gaps
[Same format]
### Medium-Priority Gaps
[Same format]
### Low-Priority Gaps
[Same format]
---
### What's Already Well-Documented
[Briefly note what's good so the team knows what not to change]
### Recommended First 3 Actions
1. [Most important thing to write first]
2. [Second]
3. [Third]
Input to Agent:
"Use the Documentation Gap Finder skill on this repo. Here's the directory tree and the current README content: [paste tree and README]"
Output from Agent:
Documentation Gap Report — MyAPI
Summary
- Critical gaps: 2
- High-priority gaps: 4
- Medium-priority gaps: 6
- Low-priority gaps: 3
Critical Gaps
1. No environment variable documentation
- Type: Missing
- Location:
README.mdor newdocs/environment.md- Impact: New developers cannot run the project locally — they don't know what
.envkeys to set- What to write: A table with every env var, whether it's required, what it does, and an example value. Found 14 undocumented env vars in
server/config.ts.2. No local setup instructions in README
- Type: Missing
- Location:
README.md- Impact: First thing a new developer needs; currently only shows badges
- What to write: Step-by-step: clone,
npm install, copy.env.example,npm run db:push,npm run devRecommended First 3 Actions
- Add a local setup section to README.md
- Document all environment variables (they're blocking the most people)
- Add JSDoc to the 8 exported functions in
src/api/auth.ts— most heavily used file with no docs