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. Use when starting a project, onboarding contributors, or when docs are missing or stale. Triggers: 'generate docs', 'document architecture', 'create api docs', 'document schema', 'project documentation', 'write architecture doc'.
npx skills add jezweb/claude-skills --skill project-docs --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# 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: | Indicator | Project Type | |-----------|-------------| | `wrangler.jsonc` / `wrangler.toml` | Cloudflare Worker | | `vite.config.ts` + `src/App.tsx` | React SPA | | `astro.config.mjs` | Astro site | | `next.config.js` | Next.js app | | `package.json` with `hono` | Hono API | | `src/index.ts` with `Hono` | API server | | `drizzle.config.ts` | Has database layer | | `schema.ts` or `schema/` | Has database schema | | `pyproject.toml` / `setup.py` | Python project | | `Cargo.toml` | Rust project | ### 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, migration
- When to Use
- Workflow
- 1. Detect Project Type
- 2. Ask What to Generate
- 3. Scan the Codebase
- 4. Generate Documentation
- Document Templates
- ARCHITECTURE.md
- APIENDPOINTS.md
- DATABASESCHEMA.md
- Quality Rules
- Updating Existing Docs
What does the project-docs skill do?
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. Use when starting a project, onboarding contributors, or when docs are missing or stale. Triggers: 'generate docs', 'document architecture', 'create api docs', 'document schema', 'project documentation', 'write architecture doc'.
How do I install it?
Run `npx skills add jezweb/claude-skills --skill project-docs --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From jezweb/claude-skills, a repository with 954 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.