Explain Codebase Area

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.

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.

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.

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.

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.