用例编写规范模板:字段清单与填写说明
用例编写规范模板需要覆盖一条用例从识别到可评审的完整信息。建议至少包含用例编号、用例名称、所属需求、参与者、前置条件、触发条件、主流程、异常流程、后置条件、业务规则、数据要求、优先级、用例类型、关联用例、编写人与评审状态等字段,并为每个字段写明填写口径。下文先给出一份可直接复制的空白表格,再逐字段说明写法、划分必填与选填,并用一条完整示例演示主流程与异常流程的填写方式。ONES 可作为承载用例文档、版本记录与评审的协作环境,模板本身仍按通用测试设计方法组织。
Table of Contents
要点总览(TL;DR)
- 用例编写规范模板建议包含用例编号、用例名称、所属需求、参与者、前置条件、触发条件、主流程、异常流程、后置条件、业务规则、数据要求、优先级、用例类型、关联用例、编写人与评审状态等字段。
- 必填字段以可执行、可追溯为准:编号、名称、所属需求、参与者、前置条件、触发条件、主流程、后置条件、优先级、编写人、评审状态;异常流程、业务规则、用例类型按条件必填。
- 主流程按“步骤—操作—预期结果”三列展开,每步一个操作对应一个可观察结果;异常流程单独成表,先写触发条件,再写处理动作和恢复后的预期结果。
- 预期结果要写到对象、状态和关键数值,例如订单状态由待提交变为待支付、余额减少99元,避免“系统正常处理”这类无法核对的表述。
- 模板本身要有版本号和变更记录,字段增删先小范围试用;用例的所属需求与需求编号保持一致,需求变更时同步检查关联用例。
可复制空白用例模板
空白模板分为两部分:上方是单条用例的基本信息表,下方是流程明细表。复制到文档工具时,把两张表放在同一页面内,流程表用编号与基本信息表的“用例编号”对应,便于一条用例展开多条流程。
基本信息表
| 字段 | 填写内容 |
|---|---|
| 用例编号 | |
| 用例名称 | |
| 所属需求 | |
| 用例类型 | |
| 优先级 | |
| 参与者 | |
| 前置条件 | |
| 触发条件 | |
| 后置条件 | |
| 业务规则 | |
| 数据要求 | |
| 关联用例 | |
| 编写人 | |
| 评审状态 |
主流程步骤表
| 步骤 | 操作 | 预期结果 |
|---|---|---|
| 1 | ||
| 2 | ||
| 3 | ||
| 4 |
异常流程表
| 编号 | 触发条件 | 处理 | 预期结果 |
|---|---|---|---|
| E1 | |||
| E2 | |||
| E3 |
后置条件与业务规则放在基本信息表中,是因为它们约束整条用例而非某一步骤。若一条用例涉及多条独立业务规则,可在业务规则栏内分行编号,并在主流程的预期结果中引用对应编号,避免规则与步骤脱节。
字段说明与填写口径
字段说明要解决的是“这一格写什么、写到什么粒度”。下表按基本信息表、主流程表、异常流程表的顺序给出定义与口径,填写人可对照使用。
| 字段 | 定义 | 填写口径与粒度 |
|---|---|---|
| 用例编号 | 用例的唯一标识 | 采用“模块缩写-序号”形式,如 ORD-012;同一需求内不重复,删除后编号不复用 |
| 用例名称 | 概括用例验证的业务行为 | 用“动作+对象+结果”表述,如“提交订单后生成待支付记录”;避免只写“订单测试” |
| 所属需求 | 用例来源的需求条目 | 填写需求编号或需求标题,便于回溯;一条用例对应一个主要需求 |
| 用例类型 | 用例的验证类别 | 按团队约定取值,如功能、边界、权限、异常处理;一条用例只选一个主类型 |
| 优先级 | 执行与维护的优先顺序 | 用高/中/低或 P0–P2,并写明判定依据,如核心交易链路为高 |
| 参与者 | 发起或参与该业务动作的角色 | 写角色而非具体人名,如“下单用户”“审核员”;涉及系统自动处理时注明系统角色 |
| 前置条件 | 执行前必须已满足的状态 | 只写可验证的状态,如“账户已实名且余额充足”;不写操作步骤 |
| 触发条件 | 启动主流程的动作或事件 | 写一个明确入口,如“点击提交按钮”或“定时任务到达执行时间” |
| 后置条件 | 用例执行完成后系统应处于的状态 | 写可检查的结果状态,如“订单状态为待支付,库存已锁定”;与预期结果呼应但不重复步骤描述 |
| 业务规则 | 约束该用例的业务约束 | 逐条编号,写清条件与结论,如“R1:单笔金额超过 5000 元需人工审核” |
| 数据要求 | 执行所需的数据准备 | 写数据种类、关键取值和数量,如“3 条有效商品、1 个余额不足账户”;敏感数据注明脱敏 |
| 关联用例 | 与本用例存在依赖或覆盖关系的用例 | 填写用例编号并注明关系,如“依赖 ORD-010 的登录态” |
| 编写人 | 用例责任人 | 写姓名或工号,便于评审时追溯 |
| 评审状态 | 用例当前所处环节 | 按团队流程取值,如草稿、待评审、已通过、需修改;状态变更时记录日期 |
主流程与异常流程的写法区别
主流程描述业务顺利走通的路径,按“步骤—操作—预期结果”三列展开,每一步只写一个操作和一个可观察结果,步骤之间保持先后顺序。异常流程描述偏离主流程的情形,单独成表,先写触发条件,再写系统或人员的处理动作,最后写恢复后的预期结果。两者的区别在于:主流程回答“正常怎么走”,异常流程回答“在什么条件下偏离、偏离后如何处理、处理完回到什么状态”。异常流程不嵌入主流程步骤中,避免一条路径里混入分支导致执行时无法判断当前处于哪条路径。
预期结果的表述要求
预期结果要写成可观察、可判断的事实,包含对象、状态和必要的数值。例如“页面提示‘支付成功’,订单状态变为已支付,账户余额减少 99 元”可以直接核对;“系统正常处理”无法判断是否通过。涉及提示信息时写出提示内容或关键字段;涉及状态变化时写出变化前后的状态;涉及数据时写出关键字段的取值。
必填与选填的划分
必填字段保证用例可执行、可追溯;选填字段服务于特定场景。划分规则应写进模板说明,避免不同编写人各自取舍。
| 类别 | 字段 | 说明 |
|---|---|---|
| 必填 | 用例编号、用例名称、所属需求、参与者、前置条件、触发条件、主流程、后置条件、优先级、编写人、评审状态 | 缺少任一项都会影响执行或追溯;主流程至少包含一个步骤 |
| 选填 | 关联用例、数据要求(无特殊数据准备时) | 按需填写;数据要求在有特定数据构造时转为必填 |
| 条件必填 | 异常流程、业务规则、用例类型 | 存在分支或约束时必须填写;纯展示类用例可只保留主流程,但需在评审记录中说明 |
条件必填的触发情形主要有三类:用例涉及金额、权限、状态流转等约束时,业务规则必填;用例存在可预期的失败路径时,异常流程必填;用例需要区分验证目的时,用例类型必填。裁剪字段时,在评审记录中写明裁剪的字段、原因和确认人,便于后续维护时判断是遗漏还是有意省略。
完整填写示例与正反示例
以下示例为演示情景,用于说明字段之间的对应关系,不代表真实项目案例。
一条完整用例
| 字段 | 填写内容 |
|---|---|
| 用例编号 | ORD-012 |
| 用例名称 | 提交订单后生成待支付记录 |
| 所属需求 | REQ-ORDER-03 订单提交 |
| 用例类型 | 功能 |
| 优先级 | 高(核心交易链路) |
| 参与者 | 下单用户 |
| 前置条件 | 用户已登录,购物车中有 1 件库存充足的商品,账户余额充足 |
| 触发条件 | 用户在确认页点击“提交订单” |
| 后置条件 | 订单状态为待支付,商品库存扣减 1 件 |
| 业务规则 | R1:单笔订单金额超过 5000 元需人工审核;R2:库存不足时不允许提交 |
| 数据要求 | 1 个有效账户、1 件单价 99 元且库存为 10 的商品 |
| 关联用例 | 依赖 ORD-010 登录 |
| 编写人 | 示例编写人 |
| 评审状态 | 已通过 |
主流程:
| 步骤 | 操作 | 预期结果 |
|---|---|---|
| 1 | 进入购物车并勾选商品 | 商品被选中,合计金额显示 99 元 |
| 2 | 点击“去结算” | 进入确认页,展示商品、金额和收货信息 |
| 3 | 点击“提交订单” | 生成订单,订单状态为待支付,页面显示订单号 |
| 4 | 查看商品库存 | 库存由 10 变为 9 |
异常流程:
| 编号 | 触发条件 | 处理 | 预期结果 |
|---|---|---|---|
| E1 | 提交时商品库存为 0 | 系统拦截提交 | 提示“库存不足”,订单不生成,库存保持 0 |
| E2 | 订单金额为 6000 元,触发 R1 | 系统转入人工审核 | 订单状态为待审核,用户看到审核提示 |
正反示例对照
| 位置 | 正例 | 反例与问题 |
|---|---|---|
| 主流程 | 点击“提交订单”→ 生成订单,状态为待支付,显示订单号 | “提交订单,系统处理订单”——操作与结果混在一起,无法判断通过标准 |
| 异常流程 | 触发条件:库存为 0;处理:拦截提交;预期结果:提示“库存不足”,订单不生成 | “库存不足时提示”——缺少处理动作和可核对的结果 |
| 预期结果 | 订单状态由“待提交”变为“待支付”,账户余额减少 99 元 | “状态正常更新”——未写状态名称和数值,执行人无法核对 |
模板的调整与维护方法
模板需要随项目类型和评审反馈调整,但调整应有触发条件和记录,避免每个项目各用一套字段导致用例无法横向比较。
字段增删的触发条件
出现以下情形时评估调整字段:同类评审意见重复出现三次以上,说明现有字段无法承载某类信息;新项目类型引入新的约束,如涉及外部系统交互需要记录接口依赖;现有字段长期为空且无人使用,可合并或删除。调整前先在小范围试用一轮,确认填写人理解口径后再推广。
模板版本与变更记录
模板本身应有版本号和变更记录,记录变更日期、变更字段、变更原因和确认人。用例文档引用模板版本,便于回溯某条用例按哪一版规范编写。版本升级时保留旧版模板,已通过评审的用例不强制回改,新编写用例使用新版本。
评审与培训方式
模板发布后安排一次填写说明讲解,用一条完整用例演示各字段写法,重点讲主流程与异常流程的分界。评审时按字段清单逐项检查必填项是否完整、预期结果是否可核对,把高频问题整理成填写问答附在模板末尾。新成员入职时以模板加示例作为上手材料。
与需求文档的关联维护
用例的“所属需求”字段应与需求文档中的需求编号保持一致。需求变更时,先更新需求条目,再检查关联用例是否需要同步修改,并在用例的评审状态中标记为“需修改”。把用例文档与需求文档放在同一协作空间中维护,可以减少编号对不上的情况。ONES Wiki 支持页面组关联项目,需求与文档可以互相对应,并记录页面版本、支持查看与回滚,适合承载模板和用例文档的版本维护;具体字段自定义与评审流转配置可在选型时结合团队流程核验。
常见问题
用例编号在删除后可以重新使用吗?
建议不复用。用例编号是对外引用和追溯的锚点,删除后若把同一编号分配给新用例,历史评审记录、缺陷单和关联用例中的引用会指向错误对象。常见做法是保留编号并标记为已废弃,新用例顺延取号;如果团队使用工具自动生成编号,应在模板说明中写明废弃编号的处理方式。
纯展示类页面是否可以不写异常流程?
可以按条件裁剪,但要在评审记录中说明。纯展示类用例没有可预期的失败路径时,可只保留主流程;一旦涉及数据加载失败、权限不足或空数据等情形,异常流程应转为必填。裁剪时记录字段、原因和确认人,后续维护时才能判断是有意省略还是遗漏。
前置条件和数据要求容易写重,怎么区分?
前置条件写执行前必须已满足的状态,数据要求写执行时需要准备的数据种类、关键取值和数量。例如“账户已实名且余额充足”属于前置条件,“1个余额不足账户、3条有效商品”属于数据要求。两者都服务于可执行性,但前者描述状态,后者描述数据构造;没有特殊数据准备时,数据要求可作为选填。
模板字段调整后,已通过评审的旧用例要不要回改?
通常不强制回改。版本升级时保留旧版模板,已通过评审的用例按原版本执行,新编写用例使用新版本;当需求变更影响到旧用例时,再在评审状态中标记为“需修改”并同步更新。这样既保持历史记录可追溯,也避免一次性大规模返工。
用例文档和需求文档放在同一协作空间维护有什么好处?
主要减少编号对不上的情况。用例的“所属需求”字段与需求编号保持一致,需求变更时先更新需求条目,再检查关联用例是否需要同步修改。ONES Wiki 的页面组可关联项目,需求与文档可以互相对应,并记录页面版本、支持查看与回滚,适合承载模板和用例文档的版本维护;具体字段自定义与评审流转配置可在选型时结合团队流程核验。



