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

发布时间 : 星期一 文章需求分析规范——附加说明1:用例描述文档编写规范更新完毕开始阅读

需求分析规范-用例编写规范 文档编号:001-0002-02 日期: 2006-07-01 选操作流程;例如,上例的“或‘退出’”备选项;

6、 有条件的备选流可以借助于其它方式进行描述,例如可以在界面原型中说明。

3.4 事件流中的序号标号

事件流中,对描述执行者和系统之间操作过程的步骤序号统一规范,使用“(1)”、“(2)”标号形式。

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

在事件流描述中,经常会遇到“确认”与“执行”之间备选操作的时候。在新一代ERP项目早期的用例描述中习惯于以下的方式:

(3) 系统显示“创建分配因子主数据界面”( CCA120-02); (4) 执行者维护“名称”、“??”属性值并确认; (5) 系统根据业务规则(BR-002)检查执行者录入; (6) 执行者执行“保存”操作;

(7) 系统根据业务规则(BR-002)再次检查并更新“分配因子”类;

这样描述之后,程序开发人员在阅读之后提出异议:在“确认”操作的时候都按照业务规则检查,“保存”时为什么还重复检查?其实用例描述的本意是允许执行者在执行“保存”之前可以先使用“确认”功能进行一次检查。

为了意思表达清楚,规定:在遇到“确认”与“执行”之间备选操作的时候使用备选流的方式进行描述,并且将“确认”功能作为备选流描述:

(3) 系统显示“创建分配因子主数据界面”( CCA120-02);

(4) 执行者维护“名称”、“??”属性值并执行“保存”(或“确认”A-02); (5) 系统根据业务规则(BR-002)检查之后,并更新“分配因子”类;

??

A-02:创建界面确认

(1) 系统按照业务规则(BR-002)检查检查界面数据项; (2) 事件流结束,返回调用点。

4. 业务规则的描述

业务规则是需求文档中对业务处理要求及处理逻辑的描述,因此,除了在事件流当中描写的处理过程之外,其它需求都应该放在业务规则中描写。

企业机密

?启明公司, 2003

Page 9 of 17

需求分析规范-用例编写规范 文档编号:001-0002-02 日期: 2006-07-01 4.1 业务规则的种类

在新一代ERP系统开发规范中,按照业务规则的应用范围(即所在文档)的不同,将其分为业务规则和公共业务规则两类,它们在描述上没有什么区别,只是作用范围不同。对于它们共同的规定有以下几方面:

1、 在用例描述文档中,对于重复使用的处理逻辑及处理规则,

2、 无论业务规则还是公共业务规则,除了给出正确的编号之外,还要给出其相应的中文名称。

中文名称的要求是:能够高度概括业务规则的主要功能;

3、 为了便于阅读,无论业务规则还是公共业务规则,在其起始处都要给出简要的注释说明;

4.1.1 业务规则的抽取及编号

这里所说的“业务规则”是用例文档中放在业务规则章节中描述的业务处理要求及处理逻辑,其有效作用范围是所在用例。

业务规则的编号为:BR-nnn,(nnn为用例中业务规则连续编号的序号); 业务规则处理

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

公共业务规则和用例文档中的业务规则没有什么特别之处,只是超过一个以上的用例共同遵循或者执行的业务规则。有的公共业务规则是为其它模块提供的“接口”。

1、 一般情况下,一个子模块的公共业务规则放在一个独立的公共业务规则文档中;

2、 公共业务规则的编号为:BR-nnn-XXX,(nnn为独立公共业务规则文档中业务规则连续编号

的序号;XXX为三位的子模块编码); 3、 公共规则一定要抽取,避免冗余陈述。

4.2 业务规则描述结构

对于软件需求的描述,根据要描述的需求的特性的不同,可以采用要点说明式的描述,也可以借鉴结构式软件开发方法,按照业务逻辑的结构进行描述。结构式描述共有三种结构方式:顺序结构、分支结构、循环结构。

无论采用哪一种描述方式,都不允许通过“转移”的方法实现业务逻辑,而是利用合理的结构体来实现各种业务逻辑关系。

4.2.1 要点说明式

对于业务逻辑非常简单、或者没有处理逻辑的需求,可以采用要点说明式的描述方式,通过若干个并列的说明条目,将需求描述清楚。

企业机密

?启明公司, 2003 Page 10 of 17

需求分析规范-用例编写规范 文档编号:001-0002-02 日期: 2006-07-01 例如:

4.2.2 顺序结构

对于具有顺序逻辑结构关系的需求,可以采用顺序结构方式进行描述。顺序结构的图示:

顺序结构可以按照操作的先后顺序逐条描写。

4.2.3 分支结构

对于具有条件约束、满足特定条件才能够执行的功能说明,可以采用分支结构方式进行描述。分支结构的图示:

NNYY(a)(b)

对于分支结构,在需求文档中使用“如果??则??”的语法进行描述, 对于图(a)的描述:

如果《条件成立》,则

《相应处理》

对于图(b)的描述:

如果《条件成立》,则

《相应处理1》

企业机密

?启明公司, 2003 Page 11 of 17

需求分析规范-用例编写规范 否则

《相应处理2》

文档编号:001-0002-02 日期: 2006-07-01 多重分支条件的描述(相当于CASE):

如果《条件1成立》,则

《相应处理1》 如果《条件2成立》,则

《相应处理2》 如果《条件3成立》,则

《相应处理3》 ??

4.2.4 循环结构

对于需要重复处理、满足特定条件才能够结束的功能说明,可以采用循环结构方式进行描述。循环结构的图示:

YNYN

(a) (b)

1、 2、 例1: 例2: 例3:

在循环结构中,一定要首先给(指出)循环处理的,也可以用对象

企业机密

?启明公司, 2003 Page 12 of 17

联系合同范文客服:xxxxx#qq.com(#替换为@)