Codebase Mapping Skill
Purpose
Systematically explore and understand an unfamiliar codebase to build a mental model.
Exploration Strategy
Phase 1: High-Level Overview
- Read README and documentation
- Examine directory structure
- Identify main entry points
- Review package.json/requirements.txt for dependencies
Phase 2: Architecture Discovery
- Find the main application entry point
- Trace the request/response flow
- Identify core abstractions and patterns
- Map module dependencies
Phase 3: Deep Dive
- Read key modules in detail
- Understand data models
- Map API endpoints to handlers
- Identify testing patterns
Key Questions
- What framework/runtime is used?
- How is the code organized (layers, features, hybrid)?
- Where is configuration managed?
- How is state managed?
- What are the main data flows?
- How are errors handled?
- What testing approach is used?
Output Artifacts
- Directory structure summary
- Architecture diagram (text or visual)
- Key file inventory
- Pattern documentation
- Convention notes for AI agents
Converted and distributed by TomeVault — claim your Tome and manage your conversions.