需求分析规范——附加说明1：用例描述文档编写规范

长春一汽启明信息技术有限公司

ERP项目

需求分析规范用例描述文档编写规范（精要）

版本 <1.0>

文档编号：001-0002-2

版本历史

目录

1.前言5

1.1目的5

1.2范围5

1.3本文档说明5

2.基本要求6

3.用例事件流的描述6

3.1基本事件流的要求7

3.2子事件流的要求7

3.3备选事件流的要求8

3.4事件流中的序号标号9

3.5事件流中“确认”与“执行”操作的描述9

4.业务规则的描述9

4.1业务规则的种类10

4.1.1业务规则的抽取及编号10

4.1.2公共业务规则的抽取及编号10

4.2业务规则描述结构10

4.2.1要点说明式10

4.2.2顺序结构11

4.2.3分支结构11

4.2.4循环结构12

4.2.5混合结构13

4.2.6注意事项13

4.3业务规则描述中的缩进规则13

4.4业务规则描述中的标号13

5.子用例的定义与描述13

5.1上级调用用例的判断方法13

6.用例描述中的其它规范14

6.1类、属性、参数的书写规则14

6.1.1类名的书写规则14

6.1.2属性名的书写规则14

6.1.3参数名的书写规则14

6.1.4各种值的书写规则14

6.2用例描述中的注释信息15

6.2.1注释要求15

6.2.2注释信息的描述15

6.3参数传递错误！未定义书签。

7.新一代ERP系统中的几个公共机制15

7.1删除完整性检查16

7.2状态管理错误！未定义书签。

7.3变更管理错误！未定义书签。

7.4权限控制错误！未定义书签。

7.5消息机制16

7.6编号管理16

7.7地址管理错误！未定义书签。

7.8长文本错误！未定义书签。

8.用例描述中用词规范16

用例描述文档编写规范（精要）

1. 前言

1.1 目的

本用例描述文档编写精要对新一代ERP项目组几年来用例设计经验进行总结，广泛吸收各方长处，分析编写过程中出现的弊端，整理出了这些编写用例文档需要掌握的要点，为指导今后需求设计、需求更改过程中文档编写起到规范的作用，不足，发现优点。还要不断地充实和完善。提高用例编写水平，

1.2 范围

本“用例描述文档编写精要”作为一个规范性的文件，适用于新一代ERP项目组需求分析与设计过程中的用例描述文档的设计工作。

1.3 本文档说明

采用说明与案例相结合的方式进行描述，便于理解。

本文档描述的内容相对比较多，每次应用时都通篇阅读比较费时。为了重点突出，文档描述中带“双下浪线”的文字都是当前章节的要点内容，便于概览阅读。

为了问题说明重点突出，所有例子都是化简之后的实例，不能认为例子与原用例的不一致就是用例错误或例子错误。

新一代ERP项目的需求规范是在开发过程中不断总结和完善的，因此，本“用例描述文档编写精要”同样需要逐步完善的过程，如果发现文档存在问题，发现需求设计工作存在问题，或者有好的建议，或者有不同见解，请及时与需求主管联系，诚谢。

系统的效率

2. 基本要求

对于用例描述文档的书写（需求设计），不同部分会有不同的要求，但是从整体上来讲应该遵循以下几项原则：

1、要从开发者的角度完善文档的可读性及处理性能；

2、要站在客户的角度考虑程序的可操作性

3、用例所用的表结构要和ROSE中的业务类图保持一致，用例中使用的类属性描述；

4、需求设计基本上还是逻辑功能设计，应该是面向任何开发工具和开发平台的。因此，在需求

文档中应该只描述出功能即可，而不应该绝对具体，以免限制设计人员针对具体开发工具的物理实现设计和程序人员的发挥；

5、在用例描述文档中对事件流、业务规则、公共业务规则、例外、扩充点、注释等内容的引

用，要进行链接，便于阅读。

3. 用例事件流的描述

用例文档中有三种事件流：基本事件流、子事件流、备选事件流，事件流编写的基本要求如下：

1、事件流描写“执行者”和“系统”的交互过程，一般不应该夹杂着业务规则和条件判断；

2、子事件流和备选事件流的确定：有的事件流在一个用例文档中既作为子事件流出现，又作为

备选事件流出现，此时没有必要把这一个事件流分别作为子事件流和备选事件流写成两个，而是以流程的执行或书写的顺序，在第一次使用这个事件流时它是子事件流，就将它放在子事件流章节中作为子事件流来书写；在第一次使用这个事件流时它是备选事件流，就将它放在备选事件流章节中作为备选事件流来书写；

3、界面流转在事件流中一定要说清楚；例如：

(2) 系统显示“选择查询战略”界面（CCA120-09）。

(3) 执行者选择“按信息结构查询”。

(4) 系统根据条件 {“应用环境”=当前应用环境.并且.“物流应用程序标志”＝真} 在“物流信

息系统”类中查找符合条件的信息，显示在界面内（CCA120-10“应用程序选择”界面）。

正确的描述方法应该是：

(2) 系统显示“选择查询战略”界面（CCA120-09）。

(3) 执行者选择“按信息结构查询”。

(4) 系统进入“应用程序选择”（CCA120-10）界面，并根据条件 {“应用环境”=当前应用环境.

并且.“物流应用程序标志”＝真} 在“物流信息系统”类中查找符合条件的信息，显示在界

面内。

4、流程中描写的操作应该是一个抽象的操作功能，而不应该写成“按XX按钮”或“双击XX

项”等具体的操作方法。例如，操作者要选择“执行”操作，可以写成：

执行者选择“执行”。

系统按照XX业务规则处理发货。

而不写成：

执行者按“执行”按钮，

或

执行者双击“执行”按钮；

3.1 基本事件流的要求

任何用例都必须有基本事件流，基本事件流是一个用例的入口点，是一个用例的主要流程。编写基本事件流应该注意以下要点：

1、基本事件流描写的是一个用例的主要流程，从这个主要流程能够看出用例执行的全貌；而非

主要流程或细节流程，可以放在子事件流或备选事件流中进行描写

2、基本事件流是流程中正确处理的流程，例外流程应该作为备选事件流来描述；

3、基本事件流一定要清晰、完整，要有始有终，具有一个出口结束点；

4、基本事件流描写的步骤不宜太多（过程比较复杂的用例的基本事件流一般也要控制在20个步

骤之内）；

5、

3.2 子事件流的要求

子事件流是另一个前序事件流中一个处理步骤的细节交互处理过程。编写子事件流应该注意以下要点：

1、子事件流要放在用例文档的“子事件流”章节中，子事件流的编号为“S-nn”（nn是从01

开始的连续的两位数字编号）；

2、子事件流的定义除了要有子事件流编号之外，还应该给子事件流一个中文名称，便于阅读。

例如：