# Codebase Documenter

Generates comprehensive documentation explaining how a codebase works, including...

- Repository: https://github.com/mhattingpete/claude-skills-marketplace (689 stars)
- Category: Writing
- License: Apache-2.0
- Last updated: 2026-07-25
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add mhattingpete/claude-skills-marketplace --skill codebase-documenter -g -a claude-code -y`
Codex: `npx skills add mhattingpete/claude-skills-marketplace --skill codebase-documenter -g -a codex -y`
Cursor: `npx skills add mhattingpete/claude-skills-marketplace --skill codebase-documenter -g -a cursor -y`
Gemini CLI: `npx skills add mhattingpete/claude-skills-marketplace --skill codebase-documenter -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add mhattingpete/claude-skills-marketplace`

## Description

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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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
- Development workflow
- Code review guidelines
- Testing requirements
- Documentation updates

## Approach

1. **Explore** using Explore agent (thorough)
2. **Map structure** with Glob
3. **Read critical files** (README, entry points, core modules)
4. **Identify patterns** with Grep (imports, exports)
5. **Trace execution** paths
6. **Extract knowledge** from docs, comments, tests
7. **Synthesize** into cohesive documentation

## Output

The rest: https://github.com/mhattingpete/claude-skills-marketplace/blob/HEAD/productivity-skills-plugin/skills/codebase-documenter/SKILL.md