# Codebase Explainer

> Explain the structure, responsibilities, entry points, and dependencies of a directory, module, or feature. Use it to understand an unfamiliar codebase or gather context before making changes.

- Skill: `lteawoo/codebase-explainer` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add lteawoo/codebase-explainer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lteawoo/codebase-explainer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: lteawoo (https://skillmd.com/u/lteawoo)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/lteawoo/codebase-explainer

---


# Codebase Explainer

## Purpose
Explain part or all of a codebase so someone can understand its structure quickly.

## Core Principles
1. Explain structure and roles before listing files.
2. Separate confirmed facts from inferences.
3. Prioritize entry points, core modules, data flow, and dependencies.
4. Surface change-sensitive boundaries before diving into implementation details.
5. Tell the reader what to inspect next.

## Inputs
- Target path or module
- Perspective to focus on
  - overall structure
  - feature flow
  - data flow
  - dependencies
  - modification points
- Related issue or change context, if available

## Workflow
1. Define the analysis scope.
2. Identify entry points and the main responsibility units.
3. Summarize the primary flow at a high level.
4. Explain module relationships and boundary points.
5. Document coupling points and validation points that matter for changes.
6. Suggest the next files or functions to read.

## Output Format

### One-Line Summary
- What this area does

### Structural Overview
- Key directories or modules
- Responsibility of each

### Main Flow
- Where requests or input begin
- Key processing stages
- How it reaches storage, response, or rendering

### Key Boundaries
- External integration points
- State transition points
- Shared contracts or interfaces

### Change Points
- Files to inspect first when changing this area
- Related areas that must be checked together
- High-regression-risk spots

### Recommended Next Steps
- Files or symbols to inspect more deeply
- Questions that still need answers

## When Information Is Missing
- Explain only what can be verified from the current context.
- Do not fill gaps with guesses; label them as "needs confirmation."
- If the scope is large, summarize the top-level structure first and suggest deeper follow-up targets.