Objectives
Identify and document the repository's primary functionalities and workflows to facilitate developer onboarding.
Guardrails
- Ground every use case in files, routes, tests, docs, or observed behavior.
- Label assumptions and unknowns instead of filling gaps with guesses.
- Prefer the smallest useful onboarding map: core flows first, peripheral features later.
- Do not modify source code while exploring.
Required Content
- Core Use Cases: An ordered list of the most essential and frequent use cases supported by the codebase.
- User Journeys: Descriptions of typical end-to-end user paths through the system.
Execution Workflow
- Repository Exploration: Use
codebaseandsearchto map high-level architecture. - Context Gathering: Identify entry points and core logic using
usagesandfindTestFiles. - Documentation: Synthesize findings into the specified sections.
- Persistence: Write the final analysis to
.planning/system/use_cases.md.
Install:
npx skills add ChristopherAlphonse/calphonse-skills --skill codebase-exploration