project-docs

Featured

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 1,031 stars 104 forks Updated today MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
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
11 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

document-project

Generate comprehensive, professional project documentation structures including README, ARCHITECTURE, USER_GUIDE, DEVELOPER_GUIDE, and CONTRIBUTING files. Use when the user requests project documentation creation, asks to "document a project", needs standard documentation files, or wants to set up docs for a new repository. Adapts to Python/Go projects and OpenSource/internal contexts.

48 Updated today
jjmartres
AI & Automation Solid

docs-project

Project (engineering) documentation branch — the 'how': README, ENTRY, AGENT/DELIVERY runbooks, and docs/ (REFERENCE map, ARCHITECTURE, ADR, SAGA, TEST_CASES, DEV_GUIDE, IMPROVEMENTS, TROUBLESHOOTING, BACKLOG, REVIEW, STATUS) plus contracts/ (OpenAPI/AsyncAPI — machine truth written BEFORE code). The map rule: every doc gets a card in REFERENCE.md. Full catalog + checklist in references/project-docs.md. Triggers: 'проектная документация', 'архитектура документация', 'adr', 'engineering docs', 'документация разработчика', 'контракты openapi', 'project docs', 'инженерная документация'.

6 Updated 2 weeks ago
bestdeejay-design
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.

46 Updated 1 months ago
martinffx