AgentSkillsCN

onboarding-start

为代码库或功能创建全面的入门文档。当用户请求“为X创建入门文档”时使用。

SKILL.md
--- frontmatter
name: onboarding-start
description: Create 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).

PhaseArtifactSkill
1-2{name}_source_inventory.md, {name}_extraction_tables.mdonboarding-analyzer
3{name}_gaps_pitfalls.mdonboarding-gaps-verifier
4{name}_onboarding_doc.mdonboarding-writer