Efficient Create Onboarding Guide

Generate comprehensive developer onboarding documentation tailored to your project's tech stack and workflows.

When to Use This Command

Run this command when you need to:

• Create a structured onboarding guide for new developers joining the project
• Document environment setup, architecture overview, and development workflows in one pass
• Generate role-specific onboarding materials with progressive learning milestones

Consider alternatives when:

• You need to update a single section of an existing onboarding guide
• The project is a personal side project with no team onboarding needs

Quick Start

Configuration

Copy
name: efficient-create-onboarding-guide
type: command
category: documentation

Example Invocation

Copy
claude command:run efficient-create-onboarding-guide --role frontend --depth comprehensive

Example Output

Project Analysis:
  Tech Stack: Next.js, TypeScript, Tailwind CSS, PostgreSQL
  Tools: pnpm, Docker, GitHub Actions
  Team Size: 8 contributors (from CODEOWNERS)

Generated Onboarding Guide:
  [+] 01-welcome.md (project overview, team contacts)
  [+] 02-environment-setup.md (tools, dependencies, verification)
  [+] 03-architecture.md (system design, key modules, data flow)
  [+] 04-development-workflow.md (branching, PRs, code review)
  [+] 05-testing.md (test framework, running tests, coverage)
  [+] 06-deployment.md (CI/CD pipeline, environments, releases)
  [+] 07-first-tasks.md (starter issues, learning milestones)
  [+] 08-faq.md (common questions, troubleshooting)

Output: docs/onboarding/ (8 files, 4,200 words total)
Estimated onboarding time: 2-3 days for a mid-level developer

Core Concepts

Onboarding Content Overview

Aspect	Details
Environment Setup	Step-by-step installation with verification commands
Architecture Guide	System diagram, module responsibilities, data flow paths
Workflow Documentation	Git branching strategy, PR process, review standards
Testing Guide	Framework setup, writing tests, coverage requirements
First Tasks	Progressive difficulty issues for hands-on learning

Guide Generation Workflow

  Analyze Project
       |
       v
  +-------------------+
  | Detect Tech Stack |---> package.json, configs, CI files
  +-------------------+
       |
       v
  +-------------------+
  | Map Architecture  |---> Directory structure, key modules
  +-------------------+
       |
       v
  +-------------------+
  | Document Workflow |---> Git, CI/CD, deployment process
  +-------------------+
       |
       v
  +-------------------+
  | Create First Tasks|---> Starter issues, milestones
  +-------------------+
       |
       v
  +-------------------+
  | Assemble Guide    |---> Ordered markdown files
  +-------------------+

Configuration

Parameter	Type	Default	Description
role	string	general	Target role: frontend, backend, fullstack, devops, qa
depth	string	standard	Detail level: quick-start, standard, or comprehensive
output_dir	string	docs/onboarding	Directory to write onboarding guide files
include_faq	boolean	true	Generate an FAQ section from common project questions
include_milestones	boolean	true	Include 30/60/90 day learning milestones

Best Practices

1. Make Setup Verifiable - Every installation step should end with a verification command that proves it worked. Instead of "Install Docker", write "Install Docker, then run docker --version to confirm version 24.x or higher."

2. Include Real Examples - Use actual project commands, file paths, and URLs rather than generic placeholders. A new developer should be able to copy-paste commands directly from the guide.

3. Keep Architecture Visual - Include ASCII diagrams or references to architecture diagrams. A visual overview of system components and their relationships is worth pages of prose.

4. Update When Things Change - Onboarding guides become harmful when they contain outdated instructions. Include a "last updated" date and assign ownership so someone is responsible for keeping it current.

5. Provide Escape Hatches - For each setup step, include troubleshooting notes for common failures. A new developer stuck on step 2 with no guidance will waste hours or give up entirely.

Common Issues

1. Guide References Non-Existent Files - The generated guide references README.md or CONTRIBUTING.md files that do not exist in the project. Verify all referenced files exist before including them in the guide.

2. Environment Setup Fails on Different OS - Instructions written for macOS do not work on Linux or Windows. Include platform-specific notes or conditional instructions for the most common development operating systems.

3. Starter Tasks Are Too Complex - The "good first issues" require deep system knowledge. Ensure first tasks are truly self-contained and can be completed with only the information in the onboarding guide.