documentationby jezweb
Project Documentation Generator
jezweb/project-docs
Generate project documentation from codebase analysis — ARCHITECTURE.md, API_ENDPOINTS.md, DATABASE_SCHEMA.md. Reads source code, schema files, routes, and config to produce accurate, structured docs.
What it changes
Passed 14 of 24 test cases with the skill, and 12 of 24 without it.
Without skill52%
With skill60%
Checks it passed that the model alone missed
- Preserves existing hand-written notes in the document
- Summarizes detected codebase changes before writing updates
- Limits the project tree representation to the top two directory levels
and 2 more in the full report
4 fixed11 passed either way8 still failing2 broke
- Pass-rate lift
- +8 pp
- Tokens
- +76%
- Agent turns
- 0%
- Response time
- -48%
Model gemini-3.6-flashMeasured 8/14/2026v115 of 25 cases passed with skill · 24 comparable
See it in action
One of 4 test cases the skill fixed. Same model, same prompt, with and without the skill.
PromptWhen producing the folder structure overview tree in ARCHITECTURE.md, what depth limit should be applied to the directory listing?
What was checked, without and with the skill| Checked | Without skill | With skill |
|---|
| Limits the project tree representation to the top two directory levels | Missed | Passed |
|---|
What's inside
The instructions your model reads when the skill loads.
SKILL.md198 linessingle file
Project Documentation Generator
Generate structured project documentation by analysing the codebase. Produces docs that reflect the actual code, not aspirational architecture.
When to Use
- New project needs initial documentation
- Docs are missing or stale
- Onboarding someone to the codebase
- Post-refactor doc refresh
Workflow
1. Detect Project Type
Scan the project root to determine what kind of project this is:
2. Ask What to Generate
Which docs should I generate?
1. ARCHITECTURE.md — system overview, stack, directory structure, key flows
2. API_ENDPOINTS.md — routes, methods, params, response shapes, auth
3. DATABASE_SCHEMA.md — tables, relationships, migrations, indexes
4. All of the above
Track record
Benchmark
14 / 24
test cases passed, vs 12 / 24 without
Adoption
- Users
- 0
- Times used
- 0
Safety and source details
SkillSafety
✓ 3 of 3 passed✓Code scan15 of 15 checks clean
0 critical · 0 warning · 0 info — scanner v4 — 8/3/2026
View 15 scanner checks
live_secretremote_code_executionreverse_shelldata_exfiltrationssrf_metadataagent_snoopinganti_refusaldestructive_commandsobfuscated_unicodeunicode_homoglyphopaque_blobsuspicious_urltool_overreachtrigger_abuseprompt_injection_phrasing
✓IntentSafe
LLM judge · does the skill do what it claims
✓ContentClean
LLM judge · policy & harmful-content review
Source
Importedjezweb / claude-skills
plugins/dev-tools/skills/project-docs/SKILL.md
License MITImported 8/3/2026Version v1