Create Onboarding Guide
Create comprehensive developer onboarding guide with environment setup, workflows, and interactive tutorials
$ npx claude-code-templates@latest --command="documentation/create-onboarding-guide" --yesRequires Claude Code. The command adds this command to your project's .claudedirectory — nothing runs on ToolZip's servers.
What's inside this command
Component source
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:
- Onboarding Requirements Analysis
- 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
- Development Environment Setup Guide
- 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
- Project and Codebase Overview
- 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
- Development Workflow Documentation
- 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
- Team Communication and Collaboration
- 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
- Learning Resources and Training Materials
- 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
- First Tasks and Milestones
- 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
- Security and Compliance Training
- Create data handling and privacy guidelines
- Provide compliance training and certification requirements
- Document incident response and security procedures
- Create security best practices and guidelines
- Tools and Resources Access
- 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
- Feedback and Continuous Improvement
- 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
Related Claude Code Commands
Create Architecture Documentation
Generate comprehensive architecture documentation with diagrams, ADRs, and interactive visualization
Update Docs
Systematically update project documentation with implementation status, API changes, and synchronized content
Generate Api Documentation
Auto-generate API reference documentation with multiple output formats and automated deployment
Docs Maintenance
Use PROACTIVELY to implement comprehensive documentation maintenance systems with quality assurance, validation, and automated updates
Doc Api
Generate comprehensive API documentation from code with interactive examples and testing capabilities
Troubleshooting Guide
Generate systematic troubleshooting documentation with diagnostic procedures, common issues, and automated solutions
Catalog data and component content are sourced from the open-source davila7/claude-code-templates project (MIT license). ToolZip curates the listing and writes original descriptions; every component links back to its original source. Claude Code is a product of Anthropic. ToolZip is an independent catalog and is not affiliated with or endorsed by Anthropic.