$ recombobulate _
home / tips / write-a-codebase-onboarding-guide-for-new-developers-with-claude
0

Write a Codebase Onboarding Guide for New Developers with Claude

bagwaa @bagwaa · Mar 26, 2026 · Workflows
write-a-codebase-onboarding-guide-for-new-developers-with-claude

New developers spend days trying to understand a codebase. Claude can generate a comprehensive onboarding guide by reading the actual code — not stale wiki pages.

Read through the entire project structure and generate an onboarding guide
for a new developer joining the team. Include:
- High-level architecture overview
- Key directories and what they contain
- How data flows from the API to the database
- Important patterns and conventions used
- How to set up the local dev environment
- Common gotchas and things that aren't obvious from the code
Write it as a markdown file called ONBOARDING.md

Claude will crawl the project, read key files like config, routes, models, and middleware, and produce a document that actually reflects the current state of the codebase.

You can make it more targeted for specific roles:

Write an onboarding guide for a frontend developer joining this project.
Focus on the component architecture, state management approach,
API integration patterns, and the styling conventions.
Include how to run the frontend locally and how to add a new page.

Run this periodically or as a CI step to keep the guide fresh:

claude --print "Read the codebase and update ONBOARDING.md with any changes since the last version. Preserve the existing structure." > ONBOARDING.md

The best onboarding doc is one generated from the code itself — not someone's memory of how things used to work.

~/recombobulate $ tip --comments --count=0

Log in to leave a comment.

~/recombobulate $ tip --related --limit=3
0
Scan Pending Changes for Security Issues with /security-review

The /security-review command scans your uncommitted changes for injection vectors, auth gaps, hardcoded secrets, and other common vulnerabilities.

bagwaa @bagwaa · 1 hour ago
0
Run Setup Scripts on Every Session with the SessionStart Hook

The SessionStart hook fires when any session begins or resumes, making it ideal for loading environment variables and running one-time setup scripts.

bagwaa @bagwaa · 1 hour ago
0
Write Property-Based Tests with fast-check and Claude

Ask Claude to write property-based tests for your functions using fast-check — it identifies the mathematical invariants in your code and generates tests that cover inputs you'd never enumerate by hand.

bagwaa @bagwaa · 2 hours ago