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

ERP项目 需求分析规范 用例描述文档编写规范（精要） 版本 1.0 文档编号：001-0002-2 版本历史 日期 版本 描述 作者 2006-07-01 1.0 初稿整理 吕春秋 目 录 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 业务规则的种类 9 4.1.1 业务规则的抽取及编号 10 4.1.2 公共业务规则的抽取及编号 10 4.2 业务规则描述结构 10 4.2.1 要点说明式 10 4.2.2 顺序结构 10 4.2.3 分支结构 11 4.2.4 循环结构 11 4.2.5 混合结构 12 4.2.6 注意事项 12 4.3 业务规则描述中的缩进规则 12 4.4 业务规则描述中的标号 12 5. 子用例的定义与描述 12 5.1 上级调用用例的判断方法 13 6. 用例描述中的其它规范 13 6.1 类、属性、参数的书写规则 13 6.1.1 类名的书写规则 13 6.1.2 属性名的书写规则 13 6.1.3 参数名的书写规则 13 6.1.4 各种值的书写规则 13 6.2 用例描述中的注释信息 14 6.2.1 注释要求 14 6.2.2 注释信息的描述 14 6.3 参数传递 14 7. 新一代ERP系统中的几个公共机制 14 7.1 删除完整性检查 14 7.2 状态管理 14 7.3 变更管理 15 7.4 权限控制 15 7.5 消息机制 15 7.6 编号管理 15 7.7 地址管理 15 7.8 长文本 15 8. 用例描述中用词规范 15 用例描述文档编写规范（精要） 前言 目的 本用例描述文档编写精要对新一代ERP项目组几年来用例设计经验进行总结，广泛吸收各方长处，分析编写过程中出现的弊端，整理出了这些编写用例文档需要掌握的要点，为指导今后需求设计、需求更改过程中文档编写起到规范的作用，不足，发现优点。还要不断地充实和完善。提高用例编写水平， 范围 本“用例描述文档编写精要”作为一个规范性的文件，适用于新一代ERP项目组需求分析与设计过程中的用例描述文档的设计工作。 本文档说明 采用说明与案例相结合的方式进行描述，便于理解。 本文档描述的内容相对比较多，每次应用时都通篇阅读比较费时。为了重点突出，文档描述中带“双下浪线”的文字都是当前章节的要点内容，便于概览阅读。 为了问题说明重点突出，所有例子都是化简之后的实例，不能认为例子与原用例的不一致就是用例错误或例子错误。 新一代ERP项目的需求规范是在开发过程中不断总结和完善的，因此，本“用例描述文档编写精要”同样需要逐步完善的过程，如果发现文档存在问题，发现需求设计工作存在问题，或者有好的建议，或者有不同见解，请及时与需求主管联系，诚谢。  系统的效率 基本要求 对于用例描述文档的书写（需求设计），不同部分会有不同的要求，但是从整体上来讲应该遵循以下几项原则： 要从开发者的角度完善文档的可读性及处理性能； 要站在客户的角度考虑程序的可操作性 用例所用的表结构要和ROSE中的业务类图保持一致，用例中使用的类属性描述； 需求设计基本上还是逻辑功能设计，应该是面向任何开发工具和开发平台的。因此，在需求文档中应该只描述出功能即可，而不应该绝对具体，以免限制设计人员针对具体开发工具的物理实现设计和程序人员的发挥； 在用例描述文档中对事件流、业务规则、公共业务规则、例外、扩充点、注释等内容的引用，要进行链接，便于阅读。 用例事件流的描述 用例文档中有三种事件流：基本事件流、子事件流、备选事件流，事件流编写的基本要求如下： 事件流描写“执行者”和“系统”的交互过程，一般不应该夹杂着业务规则和条件判断； 子事件流和备选事件流的确定：有的事件流在一个用例文档中既作为子事件流出现，又作为备选事件流出现，此时没有必要把这一个事件流分别作为子事件流和备选事件流写成两个，而是以流程的执行或书写的顺序，在第一次使用这个事件流时它是子事件流，就将它放在子事件流章节中作为子事件流来书写；在第一次使用这个事件流时它是备选事件流，就将它放在备选事件流章节中作为备选事件流来书写； 界面流转在事件流中一定要说清楚；例如： 系统显示“选择查询战略”界面（CCA120-09）。 执行者选择“按信息结构查询”。 系统根据条件 {“应用环境”=当前应用环境.并且.“物流应用程序标志”＝真} 在“物流信息系统”类中查找符合条件的信息，显示在界面内（C