codebase-reading

What problem does it solve?

This Skill provides a goal-oriented, structured approach to understanding large codebases quickly, reducing time spent wandering through files and enabling safer modifications.

Core Features & Use Cases

• Goal-driven reading: Define a one-sentence objective before diving in to guide exploration.
• Structured bootstrap: Start with high-level docs, then verify by running minimal paths and tests.
• Architecture tracing: Build an approximate system map (system context, containers, components) to keep navigation focused.
• Execution path tracing: Trace one representative request path (web/CLI/async) to understand data flow.
• Documentation discipline: Treat tests as executable docs and maintain a living terminology glossary.
• Knowledge sharing: Use git history, PRs, and tooling to preserve context and rationale.

Quick Start

• Gather the project overview (readme, docs)
• Identify the entry point (main, router, or public API)
• Trace a single end-to-end path and annotate findings
• Create a lightweight glossary and simple reference diagrams