codebase-research
Scannednpx machina-cli add skill a5c-ai/babysitter/codebase-research --openclawCodebase Research
Overview
Perform systematic codebase exploration to understand how existing systems work. Follows the Iron Law: "Do NOT explore the codebase until the problem is understood."
When to Use
- Implementation direction is clear but codebase understanding is needed
- Investigating how an existing feature works before modifying it
- Understanding dependencies and data flows before planning
- Gathering context for a known goal
Process
- Understand the request - Ask clarifying questions one at a time (purpose, specifics, scope, constraints, context). Do NOT read any files until confirmed.
- Explore the codebase - Use file-finder agent, read in order, trace data flows, identify constraints.
- Document findings - Write structured research document to
docs/plans/YYYY-MM-DD-<topic>-research.md. - Transition - Ask: plan, continue research, or conclude.
Key Rules
- Quotations from source material capped at 125 characters maximum
- Only proceed to exploration after human confirms understanding
- Use file-finder agent for initial file discovery
- Use web-researcher agent for external context needs
Agents Used
agents/file-finder/- Locates relevant files with suggested reading orderagents/web-researcher/- Gathers external context when needed
Tool Use
Invoke via babysitter process: methodologies/rpikit/rpikit-research
Source
git clone https://github.com/a5c-ai/babysitter/blob/main/plugins/babysitter/skills/babysit/process/methodologies/rpikit/skills/codebase-research/SKILL.mdView on GitHub Overview
Codebase Research is a structured method to understand how an existing system works before diving into code. It follows the Iron Law: don't read files until the problem is understood, then uses file-finder and web-researcher agents to map data flows, constraints, and dependencies.
How This Skill Works
Begin by clarifying the request to define scope. Then explore the codebase with the file-finder agent in reading order, tracing data flows and constraints. Finally, document findings to docs/plans/YYYY-MM-DD-<topic>-research.md and use the web-researcher agent for external context when needed, before transitioning to planning or continued research.
When to Use It
- Implementation direction is clear but codebase understanding is needed
- Investigating how an existing feature works before modifying it
- Understanding dependencies and data flows before planning
- Gathering context for a known goal
- When external context is required to interpret code behavior
Quick Start
- Step 1: Confirm understanding of the task with the user or stakeholder
- Step 2: Use the file-finder agent to discover relevant files and read in suggested order
- Step 3: Document findings to docs/plans/YYYY-MM-DD-<topic>-research.md and plan next steps or run external context checks with the web-researcher
Best Practices
- Ask clarifying questions before touching any file
- Use file-finder to establish a reading order and scope
- Trace data flows and identify core constraints
- Document findings in a timestamped plan file at docs/plans/YYYY-MM-DD-<topic>-research.md
- Only proceed to code exploration after human confirmation
Example Use Cases
- Clarifying a bug report's intent before scanning code paths
- Mapping data flow for a feature flag across services
- Reading a new microservice by following input/output boundaries
- Analyzing dependencies to assess refactor impact
- Creating a research brief to onboard a teammate to a code area