create-onboarding-guide — Claude Code command: setup & guide
Scans your project repository to generate tailored onboarding documentation for new team members. It extracts stack details and workflows directly from config files.
npx claude-code-templates@latest --command documentation/create-onboarding-guideWhat create-onboarding-guide does
The command inspects the project environment using Read, Write, Edit, and Bash tools. It detects dependencies across package.json or Cargo.toml. Next, it searches for docker-compose.yml, Makefiles, and GitHub workflow definitions.
Using this data, it builds an onboarding guide spanning environment setup, codebase layout, Git branching, and first milestones. You can pass role flags such as --developer, --designer, or --devops, or choose modes like --interactive and --comprehensive.
The command relies on existing repository configs. In an empty project without build files, it produces only a generic outline.
What it helps with
- generate onboarding instructions tailored to a developer or DevOps role
- document local development setup based on Docker and Makefile configs
- structure initial starter tasks and milestones for new hires
- describe team review guidelines and Git branching workflows
Example prompts for the agent
- Generate onboarding documentation for engineers: /create-onboarding-guide --developer
- Build an interactive onboarding walkthrough: /create-onboarding-guide --interactive
- Document project infrastructure and tools: /create-onboarding-guide --devops
How to install create-onboarding-guide
1claude-code-templates
npx claude-code-templates@latest --command documentation/create-onboarding-guide2Manually: put the files in place
.claude/commands/create-onboarding-guide.mdCall it with /create-onboarding-guide. For all projects use ~/.claude/commands/
Manually: put the files in place
~/.codex/prompts/create-onboarding-guide.mdCall it with /prompts:create-onboarding-guide. Codex marks this format deprecated in favour of skills
Manually: put the files in place
.github/prompts/create-onboarding-guide.prompt.mdManually: put the files in place
.gemini/commands/create-onboarding-guide.tomlGemini stores commands as TOML: the prompt text goes into the prompt field
Questions about create-onboarding-guide
How to install create-onboarding-guide in Claude Code?
Run npx claude-code-templates@latest --command documentation/create-onboarding-guide. You can also manually place the prompt file at .claude/commands/create-onboarding-guide.md.
What does create-onboarding-guide do?
It inspects repository files to detect build scripts, environment templates, and CI configs. Then it outputs an onboarding document covering setup steps and team workflows.
Which arguments and roles can you pass to the command?
It accepts role flags like --developer, --designer, and --devops, along with options like --interactive and --comprehensive.
Source text
create-onboarding-guide.md · MIT
---
allowed-tools: Read, Write, Edit, Bash
argument-hint: "[role-type] | --developer | --designer | --devops | --comprehensive | --interactive"
description: Create comprehensive developer onboarding guide with environment setup, workflows, and interactive tutorials
---
# Developer Onboarding Guide Generator
Create developer onboarding guide: $ARGUMENTS
## Current Team Context
- Project setup: @package.json or @requirements.txt or @Cargo.toml (detect tech stack)
- Existing docs: @docs/ or @README.md (if exists)
- Development tools: !`find . -name ".env*" -o -name "docker-compose.yml" -o -name "Makefile" | head -3`
- Team structure: @CODEOWNERS or @.github/ (if exists)
- CI/CD setup: !`find .github/workflows -name "*.yml" 2>/dev/null | head -3`
## Task
Create comprehensive onboarding experience tailored to role and project needs:
1. **Onboarding Requirements Analysis**
- Analyze current team structure and skill requirements
- Identify key knowledge areas and learning objectives
- Assess current onboarding challenges and pain points
- Define onboarding timeline and milestone expectations
- Document role-specific requirements and responsibilities
2. **Development Environment Setup Guide**
- Create comprehensive development environment setup instructions
- Document required tools, software, and system requirements
- Provide step-by-step installation and configuration guides
- Create environment validation and troubleshooting procedures
- Set up automated environment setup scripts and tools
3. **Project and Codebase Overview**
- Create high-level project overview and business context
- Document system architecture and technology stack
- Provide codebase structure and organization guide
- Create code navigation and exploration guidelines
- Document key modules, libraries, and frameworks used
4. **Development Workflow Documentation**
- Document version control workflows and branching strategies
- Create code review process and quality standards guide
- Document testing practices and requirements
- Provide deployment and release process overview
- Create issue tracking and project management workflow guide
5. **Team Communication and Collaboration**
- Document team communication channels and protocols
- Create meeting schedules and participation guidelines
- Provide team contact information and org chart
- Document collaboration tools and access procedures
- Create escalation procedures and support contacts
6. **Learning Resources and Training Materials**
- Curate learning resources for project-specific technologies
- Create hands-on tutorials and coding exercises
- Provide links to documentation, wikis, and knowledge bases
- Create video tutorials and screen recordings
- Set up mentoring and buddy system procedures
7. **First Tasks and Milestones**
- Create progressive difficulty task assignments
- Define learning milestones and checkpoints
- Provide "good first issues" and starter projects
- Create hands-on coding challenges and exercises
- Set up pair programming and shadowing opportunities
8. **Security and Compliance Training**
- Document security policies and access controls
- Create data handling and privacy guidelines
- Provide compliance training and certification requirements
- Document incident response and security procedures
- Create security best practices and guidelines
9. **Tools and Resources Access**
- Document required accounts and access requests
- Create tool-specific setup and usage guides
- Provide license and subscription information
- Document VPN and network access procedures
- Create troubleshooting guides for common access issues
10. **Feedback and Continuous Improvement**
- Create onboarding feedback collection process
- Set up regular check-ins and progress reviews
- Document common questions and FAQ section
- Create onboarding metrics and success tracking
- Establish onboarding guide maintenance and update procedures
- Set up new hire success monitoring and support systems
© davila7 · MIT · davila7/claude-code-templates