{"id":"codebase-documenter","name":"codebase-documenter","summary":"アーキテクチャ、主要コンポーネント、データフロー、開発ガイドラインなど、コードベースの仕組みを説明する包括的なドキュメントを生成します。","body":"# Codebase Documenter\n\nGenerates comprehensive documentation for codebases - architecture, components, data flow, development guidelines.\n\n## When to Use\n\n- \"explain this codebase\"\n- \"document the architecture\"\n- \"how does this code work\"\n- \"create developer documentation\"\n- \"generate codebase overview\"\n- \"create onboarding docs\"\n\n## What It Documents\n\n### 1. Project Overview\n- Purpose & vision\n- Target users\n- Key features\n- Technology stack\n- Project status\n\n### 2. Architecture\n- High-level structure\n- Design patterns\n- Data flow\n- Control flow\n- Diagrams (Mermaid)\n- Architectural decisions\n\n### 3. Directory Structure\n- Organization purpose\n- Naming conventions\n- Entry points\n- Core modules\n- Configuration locations\n\n### 4. Key Components\n- Major modules\n- Classes & functions\n- Responsibilities\n- Interactions\n- Extension points\n- Code examples\n\n### 5. External Integrations\n- APIs consumed\n- Databases & schemas\n- Authentication\n- Caching\n- Message queues\n- File storage\n\n### 6. Data Models\n- Database schema\n- Data structures\n- Validation\n- Migrations\n- Data transformations\n\n### 7. Development Setup\n- Prerequisites\n- Installation steps\n- Configuration\n- Running the app\n- Testing\n- Debugging\n- Troubleshooting\n\n### 8. Development Guidelines\n- Coding conventions\n- Testing approach\n- Error handling\n- Logging\n- Security practices\n- Performance patterns\n\n### 9. Deployment\n- Build process\n- Deployment steps\n- Environments\n- Monitoring\n- Rollback procedures\n\n### 10. Contributing\n- Development workflow\n- Code review guidelines\n- Testing requirements\n- Documentation updates\n\n## Approach\n\n1. **Explore** using Explore agent (thorough)\n2. **Map structure** with Glob\n3. **Read critical files** (README, entry points, core modules)\n4. **Identify patterns** with Grep (imports, exports)\n5. **Trace execution** paths\n6. **Extract knowledge** from docs, comments, tests\n7. **Synthesize** into cohesive documentation\n\n## Output\n\nCreates markdown documentation:\n```\ndocs/\n├── README.md              # Overview and quick start\n├── ARCHITECTURE.md        # System architecture\n├── DEVELOPMENT.md         # Development guide\n├── API.md                 # API documentation\n├── DEPLOYMENT.md          # Deployment guide\n└── CONTRIBUTING.md        # Contribution guidelines\n```\n\nOr single comprehensive doc if preferred.\n\n## Depth Levels\n\n- **Quick**: High-level overview (15-30 min)\n- **Standard**: Comprehensive coverage (30-60 min)\n- **Deep**: Exhaustive with examples (60+ min)\n\n## Visual Elements\n\n- Mermaid diagrams (architecture, flow charts, sequence)\n- Code examples from codebase\n- Specific file:line references\n- Tables for structured info\n- Lists for guidelines\n\n## Tools Used\n\n- **Task (Explore agent)**: Codebase exploration\n- **Glob**: Map directory structure\n- **Grep**: Find patterns, imports, exports\n- **Read**: Analyze key files\n- **Write**: Create documentation\n- **Bash**: Extract metadata (git log, versions)\n\n## Success Criteria\n\n- Complete coverage of all areas\n- Clear explanations with examples\n- Visual diagrams for complex concepts\n- Specific file:line references\n- Actionable setup/development instructions\n- New developer can onboard using only docs\n- Organized, navigable structure\n- Accurate and current information\n\n## Integration\n\n- **code-auditor**: Includes quality/security context\n- **project-bootstrapper**: Documents bootstrap decisions\n- **visual-html-creator**: Create visual diagrams","author":"@mhattingpete","ownerProfile":null,"authorContacts":null,"sourceUrl":"https://github.com/mhattingpete/claude-skills-marketplace/tree/main/productivity-skills-plugin/skills/codebase-documenter","license":"Apache-2.0","category":"document","lang":"en","tokens":790,"stars":0,"calls30d":2,"claimed":false,"visibility":"public","origin":"crawler","version":"0.1.0","createdAt":"2026-08-22","updatedAt":"2026-08-22","files":[],"requires":{"mcp":[],"tools":[]},"safety":{"flags":[],"scannedAt":"2026-08-22","hasScripts":false,"networkEndpoints":[]}}