project-docs

Solid

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

API & Backend 809 stars 82 forks Updated 2 weeks ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
97
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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, 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: ...

Details

Author
jezweb
Repository
jezweb/claude-skills
Created
7 months ago
Last Updated
2 weeks ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

code-docs

Documentation generation for code projects. Use when updating docs, writing README, generating API docs, creating changelog, or when the user mentions documentation, docs, readme, api docs, or any documentation task.

28 Updated 1 weeks ago
martinffx
Data & Documents Listed

documentation-generator

Generate comprehensive documentation for a codebase by reading the repository and producing READMEs, API docs, architecture docs, and technical references. Use when the user asks to "document this repo", "generate docs", "write a README", "create API documentation", "document this codebase", "write architecture docs", or "produce technical references" for an existing project. NOT for UX copy, button labels, or interface microcopy (use ux-writing). NOT for pedagogical code examples or tutorials (use example-design). NOT for inline code comments. NOT for navigation or sitemap design (use navigation-design).

9 Updated yesterday
viktorbezdek
Data & Documents Solid

codebase-documenter

Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.

591 Updated 2 months ago
mhattingpete
Data & Documents Listed

when-documenting-code-use-doc-generator

Automated comprehensive code documentation generation with API docs, README files, inline comments, and architecture diagrams

335 Updated today
aiskillstore
Data & Documents Listed

docs

Generate or update project documentation following the AI-DLC documentation standard. Creates README.md, CHANGELOG.md, SECURITY.md, and docs/manuals/ with audience-specific guides.

1 Updated 1 months ago
msifoss