Skills

Project Docs

Generate project documentation from codebase analysis, ARCHITECTURE.md...

Install

npx skills add jezweb/claude-skills --skill project-docs -g -a claude-code -y
Repository
jezweb/claude-skills1.1k
Category
Writing
Updated
26d ago
License
MIT
Context cost
Lightabout 1,439 tokens
Runs scripts
No, instructions only

What it does

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'.

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:

IndicatorProject Type
wrangler.jsonc / wrangler.tomlCloudflare Worker
vite.config.ts + src/App.tsxReact SPA
astro.config.mjsAstro site
next.config.jsNext.js app
package.json with honoHono API
src/index.ts with HonoAPI server
drizzle.config.tsHas database layer
schema.ts or schema/Has database schema
pyproject.toml / setup.pyPython project
Cargo.tomlRust 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, migrations, indexes
4. All of the above

Only offer docs that match the project. Don't offer API_ENDPOINTS.md for a static site. Don't offer DATABASE_SCHEMA.md if there's no database.

3. Scan the Codebase

For each requested doc, read the relevant source files:

ARCHITECTURE.md, scan:

  • package.json / pyproject.toml (stack, dependencies)
  • Entry points (src/index.ts, src/main.tsx, src/App.tsx)
  • Config files (wrangler.jsonc, vite.config.ts, tsconfig.json)
  • Directory structure (top 2 levels)
  • Key modules and their exports

API_ENDPOINTS.md, scan:

  • Route files (src/routes/, src/api/, or inline in index)
  • Middleware files (auth, CORS, logging)
  • Request/response types or Zod schemas
  • Error handling patterns
Read the whole SKILL.md on GitHub

More in Writing