Explain Codebase Area

Identify entry points, data flow, and ownership for a codebase area.

1|1|Updated Mar 31, 2026

Search Tags:#architecture #documentation #onboarding #codebase #data-flow #explain #entry-points

Ready to run

npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill explain-codebase-area

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Explain Codebase Area
Source: https://github.com/btabaska/simpler-grants-documentation-automation/tree/main/.cursor/skills/skill-explain-codebase-area
Command: npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill explain-codebase-area

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Give a reader enough structure to navigate a subsystem without reading every file. The skill identifies entry points, traces the dominant data flow, names key types, and links to applicable convention rules and ADRs.

Core Features & Use Cases

Identify entry points (route handlers, exported components, CLI commands).
Trace the dominant data flow from entry to persistence (or API boundary).
Name key types (e.g., Pydantic models, TypeScript interfaces) and link to related ADRs.
Provides a concise Markdown brief suitable for onboarding and cross-team handoffs.

Quick Start

Explain the codebase area under a specified path to a new engineer.

Frequently Asked Questions about Explain Codebase Area

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I explain a codebase area for engineering onboarding?▼

To explain a codebase area for onboarding, identify route handlers or exported components as entry points, trace the data flow to persistence boundaries, and generate a Markdown brief listing key types and dependencies for the new engineer.

What is the best way to trace data flow across a subsystem for a PR review?▼

Tracing data flow across a subsystem for a PR review involves mapping the dominant path from entry points like CLI commands to API boundaries, naming key types like Pydantic models, and linking to governing ADRs to provide architectural context.

How do I document entry points and key types for cross-team handoffs?▼

Documenting entry points and key types for cross-team handoffs requires producing a concise Markdown brief that identifies route handlers, traces data flow to persistence, and links related ADRs to give readers enough structure to navigate without reading every file.

Does this approach work for identifying architecture rules and ADRs in a codebase?▼

Yes, this approach works for identifying architecture rules and ADRs in a codebase by explicitly linking the identified key types and dominant data flows to applicable convention rules and ADRs within the generated Markdown documentation brief.

When do I need to generate a data-flow brief for a codebase area?▼

You need to generate a data-flow brief for a codebase area during engineering onboarding, cross-team handoffs, or PR reviews when a reader lacks the context to navigate a subsystem and needs to understand entry points, ownership, and persistence boundaries without reading every file.