用途
onboard 技能用于为新加入的贡献者或智能体生成一份入职文档,内容涵盖项目状态、约定以及与指定角色相关的优先级。它帮助新人快速了解项目背景、自身职责和当前工作重点。
主要能力
- 根据角色或领域(如程序员、设计师、叙事、QA、制作)生成针对性的入职文档。
- 加载项目上下文:读取 CLAUDE.md 获取项目概览和标准,读取 .claude/agents/ 中相关角色定义。
- 扫描相关领域:程序员扫描代码根目录(按 .claude/docs/code-root-resolution.md 解析),设计师扫描 design/,叙事扫描 design/narrative/,QA 扫描 tests/,制作扫描 production/。
- 读取近期变更(如 git log)以了解当前进展。
- 生成结构化文档,包含项目摘要、角色说明、架构、关键目录与文件、标准约定、当前状态、冲刺上下文、关键依赖、常见陷阱、首批任务和待问问题。
- 在输入缺失时明确报告 NOT ASSESSED — NO DATA,避免虚假通过。
使用方式
该技能通过命令调用,可指定角色,例如 /onboard programmer。执行流程分为五个阶段:
- 加载项目上下文:读取 CLAUDE.md 和角色定义。若缺失,报告为安装缺失。
- 扫描相关领域:根据角色扫描对应目录,读取近期变更。若无角色或领域,则进行一般性定位,列出 design/、docs/architecture/、production/ 和代码根目录的顶层,读取 production/session-state/active.md(若存在),并提示指定角色可聚焦下一轮。
- 生成入职文档:按模板填充各章节。
- 保存文档:向用户展示文档,询问是否写入 production/onboarding/onboard-[role]-[date].md,若同意则写入并创建目录。
- 后续步骤:判定为 COMPLETE,建议在首次会话前分享文档,运行 /sprint-status 展示当前进度,运行 /help 获取下一步指导。
自动化模式解析:通过 hooks/yaml-helper.sh 解析 modes.automation(project.local.yaml → project.yaml → 默认 collaborative)。所有 AskUserQuestion 调用和文件写入遵循 .claude/docs/automation-modes.md(collaborative 总是询问 · guided 仅主要事项 · autonomous 记录并继续;automation_always_ask 类别总是提示)。
适用场景
- 新贡献者或智能体加入游戏开发项目时,需要快速了解项目状态和自身角色。
- 团队需要为特定角色(如程序员、设计师、QA)生成定制化的入职材料。
- 项目需要确保新成员了解当前冲刺上下文、依赖关系和常见陷阱。
限制
- 若所需输入缺失,相关章节标记为 NOT ASSESSED — NO DATA,不进行估算或推断。
- 若所有必需输入均缺失,整个判定为 NOT ASSESSED — NO DATA,并指出缺失内容及应由哪个技能生成。
- CLAUDE.md 和 .claude/agents/ 由框架提供,没有技能会创建它们;若缺失,报告为安装缺失。
- 代码根目录未解析时,相关章节读取 NOT ASSESSED — code root unresolved,不会猜测 src/。
- 文档保存需用户确认。
- 具体收费、价格、平台等信息暂未提供。