Back to Details

onboard

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Phase 1: Load Project Context

第一阶段：加载项目上下文

Read CLAUDE.md for project overview and standards.
Read the relevant agent definition from 
.claude/agents/
if a specific role is specified.
阅读CLAUDE.md了解项目概述与标准。
如果指定了特定角色，请从
.claude/agents/
中读取相关的Agent定义。

Phase 2: Scan Relevant Area

第二阶段：扫描相关领域

  • For programmers: scan 
    src/
    for architecture, patterns, key files
  • For designers: scan 
    design/
    for existing design documents
  • For narrative: scan 
    design/narrative/
    for world-building and story docs
  • For QA: scan 
    tests/
    for existing test coverage
  • For production: scan 
    production/
    for current sprint and milestone
Read recent changes (git log if available) to understand current momentum.
  • 针对程序员：扫描
    src/
    目录了解架构、模式与关键文件
  • 针对设计师：扫描
    design/
    目录查看现有设计文档
  • 针对叙事创作者：扫描
    design/narrative/
    目录查看世界观构建与故事文档
  • 针对QA人员：扫描
    tests/
    目录了解现有测试覆盖范围
  • 针对生产人员：扫描
    production/
    目录查看当前冲刺与里程碑
查看近期变更（若可用则查看git log）以了解当前项目进展。

Phase 3: Generate Onboarding Document

第三阶段：生成入职文档

markdown
undefined
markdown
undefined

Onboarding: [Role/Area]

入职指南：[角色/领域]

Project Summary

项目摘要

[2-3 sentence summary of what this game is and its current state]
[用2-3句话总结该游戏的内容及当前状态]

Your Role

你的角色

[What this role does on this project, key responsibilities, who you report to]
[该角色在项目中的职责、核心任务以及汇报对象]

Project Architecture

项目架构

[Relevant architectural overview for this role]
[与该角色相关的架构概述]

Key Directories

关键目录

DirectoryContentsYour Interaction
目录内容你的交互方式

Key Files

关键文件

FilePurposeRead Priority
文件用途阅读优先级

Current Standards and Conventions

当前标准与规范

[Summary of conventions relevant to this role from CLAUDE.md and agent definition]
[从CLAUDE.md和Agent定义中提取的与该角色相关的规范摘要]

Current State of Your Area

你的领域当前状态

[What has been built, what is in progress, what is planned next]
[已完成的工作、进行中的任务以及下一步计划]

Current Sprint Context

当前冲刺上下文

[What the team is working on now and what is expected of this role]
[团队当前正在开展的工作以及对该角色的期望]

Key Dependencies

关键依赖

[What other roles/systems this role interacts with most]
[该角色最常交互的其他角色/系统]

Common Pitfalls

常见陷阱

[Things that trip up new contributors in this area]
[该领域中新贡献者容易遇到的问题]

First Tasks

初始任务

[Suggested first tasks to get oriented and productive]
  1. [Read these documents first]
  2. [Review this code/content]
  3. [Start with this small task]
[帮助新成员快速适应并投入工作的建议初始任务]
  1. [首先阅读这些文档]
  2. [查看这些代码/内容]
  3. [从这个小任务开始]

Questions to Ask

应提出的问题

[Questions the new contributor should ask to get fully oriented]

---
[新贡献者为全面适应环境应提出的问题]

---

Phase 4: Save Document

第四阶段：保存文档

Present the onboarding document to the user.
Ask: "May I write this to 
production/onboarding/onboard-[role]-[date].md
?"
If yes, write the file, creating the directory if needed.
将生成的入职文档呈现给用户。
询问：“是否需要将此文档写入
production/onboarding/onboard-[role]-[date].md
？”
如果用户同意，则写入文件，必要时创建对应目录。

Phase 5: Next Steps

第五阶段：后续步骤

Verdict: COMPLETE — onboarding document generated.
  • Share the onboarding doc with the new contributor before their first session.
  • Run 
    /sprint-status
    to show the new contributor current progress.
  • Run 
    /help
    if the contributor needs guidance on what to work on next.
结论：COMPLETE — 入职文档已生成。
  • 在新贡献者首次参与项目前分享入职文档。
  • 运行
    /sprint-status
    向新贡献者展示当前项目进展。
  • 如果贡献者需要后续工作指导，运行
    /help
    。