codebase-study-guide_skill

Overview

This skill generates a pedagogically grounded study guide to help someone learn an unfamiliar codebase. It structures learning from purpose to systems to patterns, using evidence-based techniques like progressive disclosure, worked examples, and active exploration tasks. The output is a self-contained guide tailored to onboarding needs for Agent skills that support UI development, parameter tuning, and design iteration.

How this skill works

The skill inspects the repository to find entry points, configuration, domain models, primary flows, system boundaries, tests, and documentation. It extracts 2–3 threshold concepts, builds a concept/system map, and generates sectioned content: purpose, systems, interfaces, patterns, worked examples, diagrams, and PRIMM-style exploration tasks. Each section includes active prompts and specific file/function pointers to guide hands-on learning.

When to use it

• Onboard a new team member to the agent UI and tuning tooling
• Quickly understand architecture of an unfamiliar repo before making changes
• Create a training or reference document for cross-team collaborators
• Prepare learning materials for codebase-focused onboarding sessions
• Do a focused deep dive on a subsystem (e.g., CLI entrypoints or tuning pipeline)

Best practices

• Start the guide by explaining the problem the codebase solves, not the file tree
• Identify 2–3 threshold concepts early to orient subsequent sections
• Use progressive disclosure: overview → systems → interfaces → internals
• Include active tasks (predict, run, investigate, modify) for each major section
• Pair textual explanations with simple diagrams and one worked code example per system

Example use cases

• Full onboarding guide for a developer joining the UI/parameter-tuning team
• Architecture overview for a senior engineer evaluating integration points
• Deep dive study guide for the parameter tuning pipeline or CLI tooling
• Create a one-page study map for cross-team stakeholders to understand boundaries
• Build a teaching session: use guide sections as lesson plans with exercises