完成定义(DoD)
「做完了」不能只等于「本地跑通」。
我们用统一的完成定义,减少「我以为你说的完成 是另一个意思」。
通用完成清单
以下项默认都要满足(项目可增减,但须事先书面约定):
1. 功能与验收
- 实现范围与「本期不做」一致,无静默超范围
- 主路径可演示,关键异常路径有说明或用例
- 验收标准可勾选(谁验收、验什么、怎样算通过)
2. 质量
- 关键逻辑有测试或可重复验证步骤
- 无已知阻断缺陷;已知小问题已记录并分级
- 安全与权限:未授权访问不可达(至少覆盖主对象)
3. 可运维
- 关键路径有日志/指标,能回答「坏了怎么发现」
- 配置项有说明(环境差异写清楚)
- 有回滚或降级思路(做不到要明示风险)
4. 可交接
- 接口/操作说明更新到当前版本
- 账号、权限、密钥托管位置可知
- 下一棒知道找谁、如何复现问题
分层 DoD
| 交付类型 | 额外要求 |
|---|---|
| 接口 / API | 契约(路径、字段、错误语义)冻结或版本化;示例请求/响应 |
| 管理后台 | 角色权限矩阵;主流程操作说明(从登录到完成任务) |
| 数据迁移 | 校验方式、回滚/止损、窗口与影响说明 |
| 设备 / 现场 | 现场假设(网络、窗口、人员);回滚/重试策略 |
| 文档 | 与线上版本一致;过期或「不适用」写明 |
反例(不算做完)
- 只在开发者机器上跑过
- 「差不多能用,细节明天补」且无清单
- 只有演示脚本,没有异常与权限说明
- 上线后只有作者知道怎么运维