codebase-documenter

Solid

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 591 stars 80 forks Updated 2 months ago Apache-2.0

Install

Quality Score: 86/100

Stars 20%

92

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: 7 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 Listed

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.

1 Updated yesterday

Data & Documents Listed

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.

1 Updated 3 days ago

Data & Documents Listed

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.

1 Updated 6 days ago

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

Data & Documents Listed

code-documenter

Use when producing or improving developer-facing documentation for codebases, APIs, modules, and architecture decisions. Invoke for inline comments, docstrings, API references, onboarding guides, runbooks, and consistency audits across documentation assets.

0 Updated 1 weeks ago

Ortus-Solutions