onboarding-start

OhadRubin's avatarfrom OhadRubin

Create comprehensive onboarding documentation for a codebase or feature. Use when user asks to "create an onboarding document for X".

⭐1stars🔀0forks📁View on GitHub🕐Updated Jan 5, 2026⬇️1downloads
[Technical Writing]

When & Why to Use This Skill

The Onboarding Document Creator is a sophisticated Claude skill designed to automate the generation of comprehensive onboarding documentation for software codebases and features. By orchestrating a multi-phase workflow—including source material analysis, gap identification, and structured writing—it ensures that technical teams can produce high-quality, developer-centric guides that accelerate ramp-up time and improve project maintainability.

Use Cases

  • New Developer Integration: Automatically generate 'Getting Started' guides for complex codebases to help new hires understand architecture and setup quickly.
  • Feature Handoff Documentation: Create detailed onboarding materials for newly developed features to ensure smooth knowledge transfer between engineering and product teams.
  • Legacy Codebase Mapping: Analyze existing source code and scattered notes to produce structured documentation for older systems that lack clear entry points.
  • Technical Knowledge Base Expansion: Systematically identify documentation gaps and pitfalls to create a more robust and reliable resource for internal engineering teams.
nameonboarding-start
descriptionCreate comprehensive onboarding documentation for a codebase or feature. Use when user asks to "create an onboarding document for X".

Onboarding Document Creator

Orchestrates the creation of onboarding documentation by coordinating the onboarding-analyzer, onboarding-gaps-verifier, and onboarding-writer skills.

Procedure

  1. Setup: 1.1. Use cp to copy create_onboarding_doc.xml to the working directory with an appropriate name: bash cp /path/to/skill/create_onboarding_doc.xml ./auth_feature_onboarding.xml Do NOT Read + Write - use the Bash cp command to preserve the exact template. 1.2. Read the copied XML file to see the phases.
  2. Create a todo list with phases from the XML plan.
  3. Execute each phase using the appropriate skill:
    • source-material-gathering + key-information-extraction: Use onboarding-analyzer
    • gaps-pitfalls-identification: Use onboarding-gaps-verifier
    • document-writing: Use onboarding-writer
  4. When a phase is finished:
    • Set status="completed" on the phase element in the XML file
    • Mark the corresponding todo item as completed
  5. Continue until all phases are done.

Artifacts Produced

Name artifacts appropriately for the feature being documented (e.g., auth_source_inventory.md).

Phase Artifact Skill
1-2 {name}_source_inventory.md, {name}_extraction_tables.md onboarding-analyzer
3 {name}_gaps_pitfalls.md onboarding-gaps-verifier
4 {name}_onboarding_doc.md onboarding-writer