codebase-documenter

What the source does

• FilesystemNone observedNo reads or writes in the source
• NetworkNone observedNo outbound calls in the source
• ShellNone observedNo commands run in the source
• DependenciesPinnedNothing floats
• SecretsNone foundNo keys in source

Five audit layers

Gates applied: no behavioural pass.

Audit 0.4.1 · source sha 83fe3b79ed8a · 24 Oct 2026Report an issue or request a re-scan

• Publishermhattingpete GitHub userOwner of the repository this skill is read from
• Source foldermhattingpete/claude-skills-marketplace/productivity-skills-plugin/skills/codebase-documenterThe exact folder we audited
• LicenceApache-2.0As the repository states it
• Commit pinned for this verdict83fe3b79ed8aA new audit runs when the source changes
• Repository statusNot archivedLast push 91 days ago
• Sandboxed runNot runSkills are read, not executed; layer L4 is skipped

Its 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…

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

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

Excerpt, first 3,758 characters of SKILL.md, verbatim from the audited commit. It is text from someone else’s repository, quoted so you can judge it before your agent reads it.

git clone https://github.com/mhattingpete/claude-skills-marketplace
git -C claude-skills-marketplace checkout 83fe3b79ed8a

Works in

1. 2026-10-24
   ✓SAFE B 89 / 100

   first audit · source 83fe3b79ed8a

Questions about codebase-documenter

• github.com/mhattingpete/claude-skills-marketplace/tree/main/prod — the audited source at commit 83fe3b79ed8a and every finding aboveObserved · 24 Oct 2026

Spotted something wrong? Report a correction · Methodology