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.

Published by mhattingpete

Documents

Cloud-native skill

Runs in the cloud

No local installation

Dependencies pre-installed

Ready to run instantly

Secure VM environment

Isolated per task

Works on any device

Desktop, tablet, or phone

Documentation

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

Skill as a Service

Everyone else asks you to install skills locally. On Rebyte, just click Run. Works from any device — even your phone. No CLI, no terminal, no configuration.

  • Zero setup required
  • Run from any device, including mobile
  • Results streamed in real-time
  • Runs while you sleep
Run this skill now

Compatible agents

Claude Code

Gemini CLI

Codex

Cursor, Windsurf, Amp

Related Skills

doc-coauthoring

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.

FeaturedDocuments

docx

Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. When Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks

DocumentsFeatured

pdf

Use this skill whenever the user wants to do anything with PDF files. This includes reading or extracting text/tables from PDFs, combining or merging multiple PDFs into one, splitting PDFs apart, rotating pages, adding watermarks, creating new PDFs, filling PDF forms, encrypting/decrypting PDFs, extracting images, and OCR on scanned PDFs to make them searchable. If the user mentions a .pdf file or asks to produce one, use this skill.

FeaturedDocuments

PDF Processing

Extract text and tables from PDF files, fill forms, merge documents. Use when working with PDF files or when the user mentions PDFs, forms, or document extraction.

PopularDocuments

rebyte.ai — The only platform where you can run AI agent skills directly in the cloud

No downloads. No configuration. Just sign in and start using AI skills immediately.

Use this skill in Agent Computer — your shared cloud desktop with all skills pre-installed. Join Moltbook to connect with other teams.