Slash Command

/onboard

Explore the codebase and generate a developer onboarding guide so new team members can get up to speed fast

Install

npx claudepluginhub prostrive/claude-toolkit --plugin claude-toolkit-dev

Prompt Preview

# Developer Onboarding Guide Generator

You are a senior developer who just finished exploring a codebase. Your job is to write a clear onboarding guide for a new developer joining this project.

## Step 1: Explore the project

- Read README, setup docs, and any existing documentation
- Map the folder structure and understand what each major directory does
- Identify the tech stack, key frameworks, and important libraries
- Find the main entry points and understand how the app boots
- Look at the data models and understand the core domain
- Find the test setup and understand how to run test...

Command Content

Other plugins with /onboard

/onboard

Generates four audience-tailored onboarding guides—Contributor, Staff Engineer, Executive, Product Manager—in an onboarding/ folder with index hub.

deep-wiki

2.0k

/onboard

documentation/

Generates a developer onboarding guide by scanning project configs, structure, and docs for prerequisites, setup, workflow, key concepts. Writes to docs/onboarding.md.

claude-code-toolkit

1.4k

/onboard

spartan/

Scans new codebase, checks context and files, classifies stack, maps architecture, sets up rules, and saves knowledge to .memory/ for building.

ai-toolkit

/onboard

Initiates guided KYC customer onboarding workflow: enforces stagegates, gathers details, creates case folders with consent, runs verifications, generates Excel/PDF reports.

kyc-analyst

/onboard

Generates customized onboarding plans for new hires based on role, start date, location, tech requirements, and team details. Covers pre-arrival prep, Day 1 setup, and first 90 days.

git-pr-workflows

/onboard

godmode/

Generates codebase onboarding reports: architecture walkthroughs, key files, naming analysis, dependency maps, and guided code tours. Outputs Markdown files to docs/onboarding/ and creates a commit. Supports flags like --quick, --tour.

godmode

Stats

Parent Repo Stars0

Parent Repo Forks0

Last CommitFeb 23, 2026

Actions

View Source View Plugin View on GitHub View README

Developer Onboarding Guide Generator

You are a senior developer who just finished exploring a codebase. Your job is to write a clear onboarding guide for a new developer joining this project.

Step 1: Explore the project

Read README, setup docs, and any existing documentation
Map the folder structure and understand what each major directory does
Identify the tech stack, key frameworks, and important libraries
Find the main entry points and understand how the app boots
Look at the data models and understand the core domain
Find the test setup and understand how to run tests
Check CI/CD config (.github/workflows, etc.)

Step 2: Identify common gotchas

Look for:

Non-obvious environment setup requirements
Services that need to be running locally (databases, queues, etc.)
Env variables that aren't documented
Parts of the codebase that are particularly complex or tricky
Known issues or TODOs that a new dev might trip over

Step 3: Write the guide

Developer Onboarding: [Project Name]

What is this?

One paragraph: what does this product do and who uses it.

Tech Stack

Quick list of the main technologies and why they're used.

Getting Started

Prerequisites

What needs to be installed before anything works.

Setup Steps

Step-by-step from clone to running locally. Be specific — include exact commands.

Environment Variables

List required env vars, what they're for, and where to get them.

Project Structure

Walk through the key directories and what lives where. Focus on what a developer will actually touch.

Key Concepts

Explain 3-5 domain concepts or architectural decisions a new dev needs to understand to be effective.

Common Tasks

How to do the things developers do most:

Run the app locally
Run tests
Add a new API endpoint / UI page
Deploy (if relevant)

Gotchas & Known Issues

The stuff that isn't in the docs but will bite you.

Who to Ask

(Leave blank — team to fill in)

Write this for a developer who is technically strong but has never seen this codebase. Be specific and practical. Skip the obvious.