rm2thaddeus/codebase-documenter
codebase-documenter/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add rm2thaddeus/aitor_skills codebase-documenterInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 6, 2026, 10:45 PM82.2s1 file scanned
SKILL.md
- 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.
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
Related Skills
rm2thaddeus/dev-graph-exports
development
VerifiedTrustedCommunity
Export Dev Graph UI assets and dashboard data. Use when the user asks for structure SVG exports, timeline SVG/MP4 exports, per-commit SVGs, sprint-linked visuals, or dashboard/analytics JSON from the Dev Graph API.
4SKILL.mdUpdated Apr 11, 2026
rm2thaddeus/dashboard-creator
development
VerifiedTrustedCommunity
Create HTML dashboards with KPI metric cards, bar/pie/line charts, progress indicators, and data visualizations. Use when users request dashboards, metrics displays, KPI visualizations, data charts, or monitoring interfaces.
4SKILL.mdUpdated Apr 11, 2026
rm2thaddeus/csv-data-summarizer
development
VerifiedTrustedCommunity
Analyzes CSV files, generates summary stats, and plots quick visualizations using Python and pandas.
4SKILL.mdUpdated Apr 11, 2026
rm2thaddeus/conversation-analyzer
tools
VerifiedTrustedCommunity
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.
4SKILL.mdUpdated Apr 11, 2026