codebase-documenter

Featured

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.

Data & Documents 679 stars 96 forks Updated 2 months ago Apache-2.0

Install

View on GitHub

Quality Score: 87/100

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

Skill Content

# Codebase Documenter Generates comprehensive documentation for codebases - architecture, components, data flow, development guidelines. ## When to Use - "explain this codebase" - "document the architecture" - "how does this code work" - "create developer documentation" - "generate codebase overview" - "create onboarding docs" ## What It Documents ### 1. Project Overview - Purpose & vision - Target users - Key features - Technology stack - Project status ### 2. Architecture - High-level structure - Design patterns - Data flow - Control flow - Diagrams (Mermaid) - Architectural decisions ### 3. Directory Structure - Organization purpose - Naming conventions - Entry points - Core modules - Configuration locations ### 4. Key Components - Major modules - Classes & functions - Responsibilities - Interactions - Extension points - Code examples ### 5. External Integrations - APIs consumed - Databases & schemas - Authentication - Caching - Message queues - File storage ### 6. Data Models - Database schema - Data structures - Validation - Migrations - Data transformations ### 7. Development Setup - Prerequisites - Installation steps - Configuration - Running the app - Testing - Debugging - Troubleshooting ### 8. Development Guidelines - Coding conventions - Testing approach - Error handling - Logging - Security practices - Performance patterns ### 9. Deployment - Build process - Deployment steps - Environments - Monitoring - Rollback procedures ### 10. Contributing - Dev...

Details

Author
mhattingpete
Repository
mhattingpete/claude-skills-marketplace
Created
11 months ago
Last Updated
2 months ago
Language
HTML
License
Apache-2.0

Integrates with

Anthropic · AI

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

codebase-documenter

Use this skill when the user wants to understand, document, or explain a codebase — even if they don't say "document" explicitly. Trigger on: "explain this codebase", "how does this project work", "create onboarding docs", "document the architecture", "I'm new to this repo", "generate a codebase overview", or any request to understand unfamiliar code. Produces a single docs/CODEBASE.md with architecture, components, data flow, setup instructions, and a recommended reading path for new developers. Supports quick/standard/deep depth levels and incremental updates.

5 Updated today
opencue
AI & Automation Listed

codebase-onboarding

Auto-generate onboarding documentation from codebase analysis, tailored to the reader's experience level. TRIGGER when: user asks to onboard someone to a codebase, document this codebase, generate project documentation for new team members, write a codebase walkthrough or tour, create a getting-started guide, or explain a codebase to a specific audience. DO NOT TRIGGER when: user wants API reference docs (use language-specific tooling), or wants to understand a single file (just read it).

1 Updated 3 weeks ago
DROOdotFOO
API & Backend Featured

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

1,031 Updated today
jezweb