术语表
目的
这份文档用白话解释文档里反复出现的词。新人看到不懂的词,先查这里。
人和责任
| 词 |
白话解释 |
例子 |
| Requester 运营 Alice |
提出问题、能解释背景的人 |
客服说用户一直反馈登录报错看不懂 |
| Driver 产品 Sora、Antony 技术 |
负责把任务从记录推进到关闭的人 |
张三负责收信息、催 review、确认发布 |
| Approver 产品、业务 John |
唯一拍板的人 |
产品负责人决定这个 scope 可以做 |
| Reviewer 技术 leader Antonty |
检查方案、代码、风险的人 |
模块 owner review PR |
| Operator OpsDev/ Jesse |
负责发布、回滚、观察的人 |
值班工程师上线并看监控 |
| Business Approver 产品、业务 John or Sora |
用户可见功能的业务验收人 |
产品或运营确认页面效果可接受 |
一个人可以兼多个角色,但任务卡里必须写出来。没有写出来,就容易变成“大家都知道,但没人负责”。
三个治理角色
| 词 |
白话解释 |
主要看什么 |
| 技术负责人 |
对工程质量、架构、风险和发布负责的人 |
代码能不能安全合并、系统能不能维护、失败能不能回滚 |
| 产品负责人 |
对用户问题、优先级、验收和反馈负责的人 |
做的事情是否有价值,用户可见功能是否验收 |
| 平台 / 资深工程师 |
把规范变成可执行命令、模板、CI、脚本和排障路径的人 |
新人能不能跑起来,CI 和发布是否可靠 |
任务和范围
| 词 |
白话解释 |
例子 |
| Scope |
这次允许改什么、不改什么 |
只改登录错误文案,不改鉴权逻辑 |
| 非目标 |
明确这次不做什么 |
这次不重构登录流程 |
| 验收标准 |
怎样判断做完了 |
输入错误密码时出现指定提示,并有截图 |
| Blocked |
任务被外部问题卡住 |
等产品确认文案,超过 3 天要重新拍板 |
| Done |
任务已经验证、验收、记录完 |
不是只代表代码写完 |
代码和交付
| 词 |
白话解释 |
例子 |
| PR |
Pull Request,代码合并请求 |
在 GitHub 上请求把分支合到 main |
| Patch |
一组代码改动 |
没有 PR 系统时,也要说明改了什么 |
| CI |
自动检查系统 |
PR 后自动跑测试和构建 |
| 门禁 |
必须通过才能继续的检查 |
测试失败不能合并 |
pnpm check |
JS/TS 项目的合并前统一检查命令 |
可能包含 lint、typecheck、test、build |
| Build |
生成可运行或可发布的包 |
Web bundle、Docker image、二进制 |
| Migration |
数据库结构或数据迁移 |
新增字段、改索引、迁移历史数据 |
| Smoke |
最小冒烟验证 |
上线后验证登录、支付、核心接口可用 |
命令名不是标准本身。标准是命令背后验证了什么。不同语言的等价命令见 33-测试和质量-testing-quality.md。
发布和风险
| 词 |
白话解释 |
例子 |
| Release |
把变更发布给真实用户或真实系统 |
部署到生产环境 |
| Rollback |
发现问题后退回上一个安全状态 |
回退代码、恢复配置、关闭 feature flag |
| Feature flag |
可以快速打开或关闭功能的开关 |
新功能出问题时先关开关 |
| Runbook |
出问题时照着做的操作手册 |
服务挂了先看哪些日志、怎么回滚 |
| 事故 |
用户或生产系统已经受影响 |
登录大面积失败、数据错乱 |
| Postmortem |
事故复盘 |
记录时间线、根因、后续 action |
证据和记录
| 词 |
白话解释 |
例子 |
| Evidence |
证明工作真的完成的证据 |
测试结果、截图、日志、请求响应 |
| Artifact |
工作留下的产物 |
PR、报告、截图、构建包、测试日志 |
| Handoff |
交接说明 |
现在做到哪、下一步谁做、风险是什么 |
| ADR |
Architecture Decision Record,架构决策记录 |
为什么选择 Postgres 而不是 MySQL |
| RFC |
Request For Comments,方案评审文档 |
大改动前先写方案让大家评审 |
后续 Agent 相关词
下面这些词是后续接入 Agent 时才重点看。当前阶段先保证人能闭环。
| 词 |
白话解释 |
| Agent run |
一次 Agent 执行任务的记录 |
| Runtime |
Agent 或服务实际运行的受控环境 |
| Control plane |
管任务、执行、状态、权限、证据的控制系统 |
| Human approval gate |
需要人确认后才能继续的关口 |
下一步阅读
读完或填完这份文档后,通常继续看: