Agent Skills › mhattingpete/claude-skills-marketplace › codebase-documenter

codebase-documenter

GitHub

自动分析代码库并生成全面文档，涵盖架构、组件、数据流及开发指南。适用于理解陌生代码、创建入职文档或解释系统工作原理，提升团队知识沉淀效率。

productivity-skills-plugin/skills/codebase-documenter/SKILL.md mhattingpete/claude-skills-marketplace

Trigger Scenarios

explain this codebase document the architecture create developer documentation

Install

npx skills add mhattingpete/claude-skills-marketplace --skill codebase-documenter -g -y

More Options

Non-standard path

npx skills add https://github.com/mhattingpete/claude-skills-marketplace/tree/main/productivity-skills-plugin/skills/codebase-documenter -g -y

Use without installing

npx skills use mhattingpete/claude-skills-marketplace@codebase-documenter

指定 Agent (Claude Code)

npx skills add mhattingpete/claude-skills-marketplace --skill codebase-documenter -a claude-code -g -y

安装 repo 全部 skill

npx skills add mhattingpete/claude-skills-marketplace --all -g -y

预览 repo 内 skill

npx skills add mhattingpete/claude-skills-marketplace --list

SKILL.md

Frontmatter

{
    "name": "codebase-documenter",
    "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."
}

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

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

Output

Creates markdown documentation:

docs/
├── README.md              # Overview and quick start
├── ARCHITECTURE.md        # System architecture
├── DEVELOPMENT.md         # Development guide
├── API.md                 # API documentation
├── DEPLOYMENT.md          # Deployment guide
└── CONTRIBUTING.md        # Contribution guidelines

Or single comprehensive doc if preferred.