新人第一天怎么做
目的
这份文档给刚入职、刚加入项目、或者临时接手任务的人看。你不需要先理解完整流程,先按下面步骤做,保证自己接到的任务能被记录、执行、验证和关闭。
如果遇到不懂的词,先查 01-术语表-glossary.md。
你第一天只读这些入口
- 当前项目的
docs/PROJECT.md:这个项目怎么跑、谁负责、怎么发布。 - 02-L0最小闭环-l0-minimum-closure.md:团队最低规则。
- 01-术语表-glossary.md:常见词是什么意思。
- 13-工作入口-work-intake.md:一个任务怎样才算能开始。
- 32-PR评审-pr-review.md:代码改完以后怎样让别人能 review。
- 42-工程师入职-engineer-onboarding.md:工程师如何了解项目、协作和完成第一个 PR。
不要第一天就读完整套文档。先把一个真实任务走通。
刚入职工程师的最短路径
找到 docs/PROJECT.md
-> 跑起本地项目
-> 看 ARCHITECTURE / TECH_STACK / DEPENDENCIES
-> 领一个小 scope 任务
-> 提一个带证据的 PR
-> 根据 review 修改
-> 回写任务和文档缺口
详细做法见 42-工程师入职-engineer-onboarding.md。
接到任务时,先问 6 件事
1. 这个任务记录在哪里?
2. 谁是 Driver?
3. 谁是 Approver?
4. 这次只改什么,不改什么?
5. 怎样算完成?
6. 做完后用什么证据证明?
如果回答不出来,不要直接开工。先让 Driver 或小组长补齐任务卡。
任务卡最小样子
目标:修复登录失败时错误提示不清楚的问题。
Requester:客服负责人
Driver:张三
Approver:产品负责人
Scope:只改登录页错误提示,不改登录流程和鉴权逻辑。
验收标准:输入错误密码时显示“账号或密码错误”,有截图。
风险:影响登录页文案,不影响后端鉴权。
开始改代码前
你至少要知道:
- 要改哪个仓库、哪个模块或哪个页面。
- 当前项目的
docs/PROJECT.md在哪里。 - 本地怎么启动项目。
- 改完要跑哪些检查。
- 如果改坏了,怎么回滚。
如果文档里写的是 pnpm check,它不是神秘命令,通常表示“合并前统一检查”。它可能包含格式检查、lint、类型检查、测试和构建。不同语言有不同等价命令,见 33-测试和质量-testing-quality.md。
提 PR 或 Patch 时
PR 描述不要只写“fix bug”。至少写清楚:
关联任务:
改了什么:
怎么验证:
风险:
回滚:
Reviewer:
Approver:
证据可以很简单,但必须具体:
| 变更 | 最低证据 |
|---|---|
| 文案 / 样式 | 截图 |
| API | 请求和响应样例,或测试结果 |
| 后端逻辑 | 单测、集成测试或手动验证步骤 |
| 数据库 | migration 结果和回滚说明 |
| 发布 | smoke 结果和线上观察 |
做完以后,怎么关任务
任务不是“代码合了”就一定完成。关闭前确认:
- PR 或 patch 已经关联任务。
- 验证证据已经贴到 PR 或任务里。
- 用户可见功能有业务验收结论。
- 如果已经发布,有发布记录和回滚方式。
- 如果有遗留风险,已经新建后续任务。
你可以直接挑战的情况
遇到下面情况,普通员工也应该停下来问清楚:
- 没有 Driver 或 Approver。
- Scope 说不清,只说“顺手都改一下”。
- 要动支付、权限、客户数据、生产密钥或数据库,但没有 review。
- 要上线,但没人说怎么回滚。
- 任务做完后没人能验收。
这不是找麻烦,这是防止团队做出不可追踪、不可验证、不可回滚的工作。
下一步阅读
读完或填完这份文档后,通常继续看:
- 01-术语表-glossary.md:遇到不懂的词先查术语。
- 02-L0最小闭环-l0-minimum-closure.md:如果团队还混乱,先执行最小闭环。
- 42-工程师入职-engineer-onboarding.md:刚入职工程师继续按入职路径走。
5公里
- 引入 scrum 流程, 协作软件 worktile 服务 scrum.
- 分步骤,初步的
- 开发环境, dev , prod, runbook
- 技术文档规范
- git workflow, 分支管理
- 项目命名
- 目录,结构,模块
- 环境, 构建
- Env, 多服务不要共享
- 日志路径, 不要写死路径
- git workflow, 分支管理
- 数据库 table 字段约束
- tech_spec.md 数据库、技术选型
- QA generate report , 反馈到小组组长, @John
- 产品文档,最低结构
待讨论:
协作。筛选前5公里