需求用例编写细则.docVIP

需求用例编写规范-V1.0 文档编号： 文档名称：需求用例编写规范 文档类别：设计规范 密 级：机密 版本信息：1.0 建立日期：2005-08-26 创 建 人：016 审 核 者： 批 准 人： 批准日期： 编辑软件：Microsoft Office 2003 中文版 文档修订记录 版本编号 *变化 状态 简要说明 (变更内容和变更范围) 日期 变更人 批准日期 批准人 更改请求号 V1.0 C 参考《编写有效用例》 2005-08-26 016 *变化状态：C——创建,M——修改，D——删除 文档审批信息 序号 审批人 角色 审批日期 签字 备注 目录 1 简介 1 1.1 文档目的 1 1.2 有效范围 1 2 梗概 1 2.1 用例定义 1 2.2 用例格式 2 2.2.1 非正式用例 2 2.2.2 正式用例 3 3 非正式用例 3 3.1 用例名 3 3.2 自然语言描述体 4 3.3 图例说明 4 4 正式用例 4 4.1 范围 4 4.2 级别 4 4.3 主执行者 4 4.4 项目相关人员和利益 4 4.5 前置条件 4 4.6 最小保证 5 4.7 成功保证 5 4.8 触发事件 5 4.9 主成功场景 5 4.10 扩展场景 5 4.11 相关信息 6 4.11.1 解释说明 6 4.11.2 约束条件 7 4.11.3 改进建议 7 5 编号 7 6 批注 7 7 超链接 8 8 字体及颜色 8 9 如何快速书写需要用例 8 9.1 非正式用例 8 9.2 正式用例 9 10 范例 10 简介 文档目的 本文档中的内容是为了更好的书写与理解需求用例，阅读本文后，达到读者能够书写规范有效的需求用例。如果读者需要立即书写需求用例，则可以直接阅读第9节“如何快速书写需求用例”。本文参考Alistair Cockburn编著，王雷、张莉翻译由机械工业出版社出版的《编写有效用例（Writing Effective Use Cases）》一书，有兴趣的读者可以详细阅读此书。 有效范围 本文适用于各种软件开发项目的需求分析。 梗概 用例定义 用例是代表系统中各个项目相关人员之间就系统的行为所达成的契约，用例描述了在不同条件下，系统对某一项目相关人员的请求所作出的响应。 如果用用例来记录一个组织的业务过程，那么被讨论的系统是指组织本身，项目相关人员是指公司的股东、客户、供应商和政府管理部门，这种用例称为业务用例，业务用例可以作为软件需求采集时使用；如果用用例来记录一个软件的行为需求，那么被讨论的系统是指计算机程序，项目相关人员是指使用该程序的人、拥有该程序的公司、政府管理部门和其他一些计算机程序，这种用例称为系统用例，系统用例可以作为软件需求分析时使用。 用例不是所有的需求，用例不能详细地描述外部接口、数据格式、业务规则和复杂公式，用例只是需要收集的所有需求中的一部分，虽然这一部分是非常重要的一部分，但毕竟仅仅是“一部分”，不能全部反映“需求”。 用例格式 需求用例分为正式用例与非正式用例，非正式用例是用自然语言及图例进行用例描述，正式用例是具有规范格式的用例描述。读者在此不必深究用例如何书写，后续章节中有详细说明。 非正式用例 正式用例 非正式用例 非正式用例包括三部分：用例名、自然语言描述体、图例说明。 用例名 用例名就是用例的名称，应是一个主动语态动词短语来表示的用例目标。 自然语言描述体 用自然语言描述成功场景和可能会出现的失败场景，及其相应的处理动作，还包括用例所需要的功能操作等。 图例说明 对于较复杂的需求用例，可以用图表说明用例之间关系，使用例更加清晰明朗。 正式用例 正式用列具有格式规范，包括：用例名、自然语言描述体、图例说明、范围、级别、主执行者、项目相关人员和利益、前置条件、最小保证、成功保证、触发事件、主成功场景、扩展场景和相关信息等项目，用例格式并不是硬性规定必须包括这此内容，只是为需求用例编写者提供正式用例编写格式参考，具体项目具体分析，以增减正式用例内容，更好地为需求分析服务；用例名、自然语言描述体、图例说明的编写方法同非正式用例，只是自然语言描述体只阐述不能在主成功场景和扩展场景中描述的部分，不必将场景全部说明。 范围 范围（scope）用来描述项目开发人员负责的设计工作的边界，以便与应由其他人负责的设计工作或已经完成的设计工作相区别；范围应该是一个简单明确的名词，比如说需求人员正在对“固定资产”项目进行