本文へ移動
cccskills
無料GitHub で公開

codebase-documenter

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.

インストール方法を見る

含まれるファイル(1)

  • SKILL.md3.7 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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

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.

Depth Levels

  • Quick: High-level overview (15-30 min)
  • Standard: Comprehensive coverage (30-60 min)
  • Deep: Exhaustive with examples (60+ min)

Visual Elements

  • Mermaid diagrams (architecture, flow charts, sequence)
  • Code examples from codebase
  • Specific file:line references
  • Tables for structured info
  • Lists for guidelines

Tools Used

  • Task (Explore agent): Codebase exploration
  • Glob: Map directory structure
  • Grep: Find patterns, imports, exports
  • Read: Analyze key files
  • Write: Create documentation
  • Bash: Extract metadata (git log, versions)

Success Criteria

  • Complete coverage of all areas
  • Clear explanations with examples
  • Visual diagrams for complex concepts
  • Specific file:line references
  • Actionable setup/development instructions
  • New developer can onboard using only docs
  • Organized, navigable structure
  • Accurate and current information

Integration

  • code-auditor: Includes quality/security context
  • project-bootstrapper: Documents bootstrap decisions
  • visual-html-creator: Create visual diagrams

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Create comprehensive HTML architecture diagrams showing data flows, business objectives, features, technical architecture, and deployment. Use when users request system architecture, project documentation, high-level overviews, or technical specifications.

日本語の概要は準備中です。原文の説明を表示しています。

mhattingpete/claude-skills-marketplace6822026年7月25日 更新

Performs comprehensive codebase analysis covering architecture, code quality, security, performance, testing, and maintainability. Use when user wants to audit code quality, identify technical debt, find security issues, assess test coverage, or get a codebase health check.

日本語の概要は準備中です。原文の説明を表示しています。

mhattingpete/claude-skills-marketplace6822026年7月25日 更新

Execute Python code locally with marketplace API access for 90%+ token savings on bulk operations. Activates when user requests bulk operations (10+ files), complex multi-step workflows, iterative processing, or mentions efficiency/performance.

日本語の概要は準備中です。原文の説明を表示しています。

mhattingpete/claude-skills-marketplace6822026年7月25日 更新

Perform bulk code refactoring operations like renaming variables/functions across files, replacing patterns, and updating API calls. Use when users request renaming identifiers, replacing deprecated code patterns, updating method calls, or making consistent changes across multiple locations.

日本語の概要は準備中です。原文の説明を表示しています。

mhattingpete/claude-skills-marketplace6822026年7月25日 更新

Transfer code between files with line-based precision. Use when users request copying code from one location to another, moving functions or classes between files, extracting code blocks, or inserting code at specific line numbers.

日本語の概要は準備中です。原文の説明を表示しています。

mhattingpete/claude-skills-marketplace6822026年7月25日 更新

Analyzes your Claude Code conversation history to identify patterns, common mistakes, and opportunities for workflow improvement. Use when user wants to understand usage patterns, optimize workflow, identify automation opportunities, or check if they're following best practices.

日本語の概要は準備中です。原文の説明を表示しています。

mhattingpete/claude-skills-marketplace6822026年7月25日 更新

mhattingpete のスキルをすべて見る

このスキルの問題を報告する