Software Engineering
Create a New Engineer Codebase Tour
A newcomer-oriented tour that starts with a runnable path, explains repository boundaries and ownership, and schedules progressively deeper code-reading exercises.
The process
Work it in this order.
- Identify the new engineer role, first useful outcome, timebox, repository revision, local prerequisites, and the questions the tour should answer.
- Trace one safe happy path from an entry point through a test or artifact, recording commands, expected output, and the smallest useful change.
- Map the repository's major directories, build and deployment boundaries, data and external systems, owners, documentation, and key decisions.
- Create progressive stops with a reading question, a small exercise, a verification signal, and a clear stop before production or consequential access.
- Add a glossary, links to authoritative code and decisions, common traps, escalation contacts, and guidance for private or non-public evidence.
- Validate the tour with a teammate or a self-check from a clean environment, revise unclear steps, and record what could not be tested.
- Publish the tour with a version, update owner, evidence for each path, known limitations, and unresolved risks for future maintainers.
Bring this
Inputs the cat will ask for.
- new engineer role and first outcome
- repository and local setup instructions
- timebox and learning constraints
- owners and escalation contacts
Router + one playbook
Route first. Choose one.
Cat Paw loads one playbook per task rather than merging several. Start with this router; the remaining paths are workflow-specific candidates it can inspect.
- Router:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
Guardrails
The boundaries travel with the prompt.
- Verify the actual tools, accounts, permissions, and workspace before starting; never claim an unavailable tool, account, source, or capability.
- Use Latch/target-workspace for private code, artifacts, live probes, or non-public data; if that access is unavailable, stop at the boundary and report the blocker rather than substituting a guess.
- Pause for explicit approval before consequential external actions; return evidence and unresolved risks, assumptions, and any action still awaiting approval.
Done means
A checkable finish.
A versioned onboarding tour takes a new engineer from a verified runnable path to deeper repository knowledge, with ownership, exercises, evidence, and unresolved risks recorded.
Sources
Where this process came from.
- github.com/Egonex-AI/Understand-Anything/tree/6df3065f1d8ddc2ce3615314d1d493f36d6b1c80/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
Sources establish the workflow pattern. Reddit and community posts, where present, are treated as practitioner anecdotes rather than universal facts.