用例编写规范模板:正例与反例怎么写
用例编写规范模板里的正例和反例要成对出现:正例给出一条完整、可直接照抄的合格用例,覆盖参与者、前置条件、主流程、异常流程、后置条件;反例取自同一业务场景,只改动一处关键写法,并在旁边标注问题类型和修正方式。这样编写者能同时看到“合格长什么样”和“错在哪、怎么改”。下面给出一份可填写的字段骨架、正反示例的写法规则、一组完整示例,以及评审分工和发布前检查清单。
Table of Contents
要点总览(TL;DR)
- 模板固定七个字段:用例编号、用例名称、参与者、前置条件、主流程、异常流程、后置条件,每个字段配填写说明、正例写法要点和反例常见错误类型。
- 正例选主流程清晰、参与者和前置条件明确的典型场景,主流程按步骤写清操作者、动作和系统可见结果,前置条件与后置条件写成可验证状态。
- 反例从正例改出,同一场景只改一处,旁边标注问题类型和一句修正说明,常见错误包括参与者写成系统、前置条件写成目标、主流程混入分支、异常流程缺失、后置条件不可验证。
- 一组完整示例包含一条正例和三条反例,可迁移的规律是同场景、单点改动、成对出现,反例数量按常见错误类型选取。
- 发布前按字段完整性、正例可执行性、反例对应关系、五要素覆盖、评审记录齐全逐项检查,评审记录保留修改前后对照。
模板字段与正反示例的对应关系
模板先固定字段,再在每个字段旁放置正例写法和反例常见错误。字段数量控制在七个,避免编写者把用例写成需求说明或操作手册。每个字段都给出最低合格要求,评审时按同一口径判断。
| 字段 | 填写说明 | 正例写法要点 | 反例常见错误类型 |
|---|---|---|---|
| 用例编号 | 团队内唯一,便于在需求条目和测试记录中引用 | 按“模块-序号”或团队约定格式编写,与需求编号可对应 | 编号重复或缺失,无法追溯到需求 |
| 用例名称 | 用“参与者+动作+对象”描述一个可验证的目标 | 名称指向单一业务结果,如“会员提交订单并完成支付” | 名称写成功能模块名或包含多个目标 |
| 参与者 | 写出发起动作的人或外部系统角色 | 写业务角色,如“已登录会员”“客服专员” | 参与者写成系统本身或写成“用户”这类无法区分的泛称 |
| 前置条件 | 描述执行前必须成立、可检查的状态 | 写成可验证状态,如“账户余额不少于订单金额” | 前置条件写成目标或愿望,如“系统运行正常” |
| 主流程 | 按步骤编号,每步写操作者、动作和系统可见结果 | 一条主路径走到底,分支放到异常流程 | 主流程混入条件分支或把多个场景合并 |
| 异常流程 | 列出主流程中可能出现的失败或替代路径及系统响应 | 每条异常对应主流程的具体步骤,写明提示或回退结果 | 异常流程缺失,或只写“处理异常”没有具体响应 |
| 后置条件 | 描述用例结束后系统应处于的可验证状态 | 写成可检查的数据或状态,如“订单状态为已支付,库存扣减一条” | 后置条件不可验证,如“用户满意” |
正例与反例在字段层面保持同一位置对照:同一字段、同一业务场景、只改一处。模板可以把每个字段拆成两栏,左栏放正例写法,右栏放一条对应反例和一句修正说明,编写者填写时直接对照。
正例的写法:从场景到完整用例
正例的选取标准是主流程清晰、参与者和前置条件明确。优先选业务价值高、步骤数量适中的典型场景,避免选依赖大量外部系统或临时数据的边缘场景。选定场景后按以下步骤写出正例。
- 确定参与者:写出发起动作的业务角色,并确认该角色在前置条件下可以执行。
- 写前置条件:逐条列出执行前必须成立的状态,每条都能通过查询数据或界面确认。
- 编号主流程:每一步写清操作者、动作和系统可见结果。例如“会员在结算页点击提交订单,系统生成待支付订单并显示支付入口”。
- 补异常流程:针对主流程中可能失败的步骤,写出触发条件和系统响应,包括提示信息、状态保持或回退结果。
- 写后置条件:用可检查的数据或状态描述结束状态,与前置条件形成对应。
- 自检:请一位不熟悉该需求的同事按用例执行,若能完成操作并得到预期结果,说明正例达到可复用标准。
正例的完成标志是:他人不看需求文档也能照此执行,执行后能判断结果是否符合预期。若某一步需要读者自行猜测操作位置或判断标准,说明该步骤还需要补充系统可见结果。
反例的写法:只改一处并标注修正
反例从正例改出,共用同一业务场景,只在一个字段或一个步骤上出错。这样读者对比时能准确定位差异,不会把反例当成另一条无关用例。每条反例旁边标注问题类型和一句修正说明,修正说明直接指向正例中的正确写法。
| 错误类型 | 反例表现 | 修正说明示例 |
|---|---|---|
| 参与者写成系统 | 参与者填“订单系统” | 改为发起动作的业务角色,系统响应写进主流程步骤 |
| 前置条件写成目标 | 前置条件写“确保支付顺畅” | 改为可验证状态,如“支付渠道可用且账户余额充足” |
| 主流程混入分支 | 主流程某步写“若库存不足则提示补货” | 主流程保留正常路径,分支移到异常流程并写明系统响应 |
| 异常流程缺失 | 只写正常支付成功,未写支付失败 | 补充支付失败时的提示、订单状态和重试入口 |
| 后置条件不可验证 | 后置条件写“用户体验良好” | 改为可检查状态,如“订单状态为已支付,生成一条支付记录” |
反例的完成标志是:读者能指出错在哪个字段或步骤,并说出具体改法。若一条反例需要读者对照需求文档才能理解错在哪里,说明反例偏离了正例场景,应重新从正例改出。
完整示例:一条正例与三条反例
以下示例为演示情景,业务场景为“会员提交订单并完成支付”,可直接放入模板作为示范条目。
正例
- 用例编号:ORDER-001
- 用例名称:会员提交订单并完成支付
- 参与者:已登录会员
- 前置条件:会员已登录;购物车中至少有一件可售商品;账户余额不少于订单金额
- 主流程:
- 会员在购物车页点击“去结算”,系统展示订单确认页,包含商品明细和应付金额。
- 会员确认收货信息后点击“提交订单”,系统生成待支付订单并跳转支付页。
- 会员选择余额支付并确认,系统扣减账户余额,订单状态变为已支付,展示支付成功页。
- 异常流程:第3步余额扣减失败时,系统提示“支付失败,请重试”,订单保持待支付状态,余额不变。
- 后置条件:订单状态为已支付;账户余额减少订单金额;生成一条支付记录。
反例一(前置条件错误):前置条件写“确保会员能够顺利支付”。问题类型:前置条件写成目标。修正说明:改为可验证状态,如“账户余额不少于订单金额”。
反例二(主流程混入分支):主流程第3步写“若余额不足则提示充值,否则完成支付”。问题类型:主流程混入分支。修正说明:主流程只保留支付成功路径,余额不足的提示和订单状态写入异常流程。
反例三(异常流程缺失):异常流程只写“支付异常时处理”。问题类型:异常流程缺失具体响应。修正说明:写明触发条件、提示文案、订单状态和余额是否变化,与主流程第3步对应。
这组示例可迁移的规律是:同场景、单点改动、成对出现。团队新增用例时,先写正例,再从正例改出反例,反例数量按常见错误类型选取,不必每个字段都配反例。
角色分工与评审交付物
规范落地需要明确谁写、谁审、交付什么。编写者负责按模板填写正例和反例,评审者对照示例检查字段完整性和对应关系,需求负责人确认用例覆盖的业务场景与需求一致。
| 角色 | 主要动作 | 交付物 |
|---|---|---|
| 编写者 | 按模板字段填写正例,从正例改出反例并标注修正说明 | 用例文档、正反示例条目 |
| 评审者 | 对照正例检查可执行性,对照反例检查是否单点改动、修正说明是否准确 | 评审记录、修改清单 |
| 需求负责人 | 确认用例场景与需求条目对应,判断异常流程是否覆盖关键失败路径 | 评审结论、需求与用例的对应关系 |
评审通过的判定依据包括:字段无缺失;正例可被他人直接执行;每条反例与正例同场景且只改一处;反例旁有明确的问题类型和修正说明。评审记录中保留修改前后的对照,便于后续追溯。
当团队把用例规范作为文档资产维护时,可以把模板放入知识库统一管理。ONES Wiki 提供页面模板库,可一键创建制式化文档模板,页面组可关联项目,使需求与文档互相对应;文档实时同步并记录页面版本,支持查看与回滚。用例条目和评审修改状态也可以在 ONES 的用例库、测试计划与需求池中承载,形成需求—任务—测试—缺陷的闭环,便于评审结论和修改记录跟随需求追溯。
完成检查:模板与示例是否可用
发布前按以下清单逐项核对,全部通过即可作为团队模板使用。
- 字段完整性:七个必备字段均有填写说明和最低合格要求,没有空缺字段。
- 正例可执行性:请一位未参与编写的同事按正例执行,能完成操作并判断结果是否符合预期。
- 反例对应关系:每条反例与正例同场景,只改动一个字段或一个步骤,旁边有问题类型和一句修正说明。
- 五要素覆盖:示例覆盖参与者、前置条件、主流程、异常流程、后置条件,且每个要素都有正例写法和至少一种反例错误类型。
- 异常流程可验证:每条异常流程写明触发条件、系统响应和结束状态,不停留在“处理异常”这类描述。
- 后置条件可检查:后置条件能通过数据或界面状态确认,与前置条件形成对应。
- 评审记录齐全:用例文档、评审记录和修改清单已归档,修改前后可对照。
检查中发现问题的条目,回到对应章节修订:字段问题改模板,正例问题补系统可见结果,反例问题重新从正例改出并补修正说明。
常见问题
反例是不是每个字段都要配一条?
不需要。反例数量按团队常见错误类型选取,优先覆盖出现频率高、影响评审判断的错误,例如前置条件写成目标、主流程混入分支、异常流程缺失。字段本身仍要在模板中给出填写说明和正例写法要点,反例可以集中放在错误类型标注表里,与正例成对呈现即可。
正例和反例可以来自不同业务场景吗?
不建议。反例从正例改出、共用同一业务场景,读者对比时才能准确定位差异。若反例换成另一个场景,读者需要同时理解两套业务背景,容易把反例当成另一条无关用例。团队可以准备多组正反示例覆盖不同业务线,但每一组内部保持同场景、单点改动。
用例编写规范和需求文档之间怎么对应?
用例编号按团队约定格式编写,并与需求编号建立对应关系,评审时由需求负责人确认用例场景与需求条目一致。这样修改需求或用例时能顺着编号找到关联条目。团队把模板作为文档资产维护时,可以把模板放入知识库统一管理,ONES Wiki 提供页面模板库,可一键创建制式化文档模板,页面组可关联项目,使需求与文档互相对应。
评审时发现反例写得不对,应该改反例还是改正例?
先判断问题出在哪一层。如果反例偏离了正例场景或改动了多处,重新从正例改出;如果正例本身某一步缺少系统可见结果,先补正例,再据此调整反例和修正说明。评审记录中保留修改前后的对照,便于后续追溯。用例条目和评审修改状态可以在 ONES 的用例库、测试计划与需求池中承载,形成需求—任务—测试—缺陷的闭环。
模板发布后,新增用例还要不要继续补反例?
按需补充。模板中的反例主要用于示范错误类型和修正方式,新增用例以写正例为主;当团队反复出现某类错误时,再从正例改出一条对应反例补进模板,并同步更新错误类型标注表。这样模板随评审中暴露的问题逐步完善,避免为了凑数量而堆叠反例。



