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

SUBJECT ERP项目 需求分析规范 用例描述文档编写规范（精要） 版本 1.0 文档编号：001-000 版本历史 日期 版本 描述 作者 -07-01 1.0 初稿整理 吕春秋 目 录 TOC \o 1-3 \h \z 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中业务类图保持一致，用例中使用类属性描述； 需求设计基础上还是逻辑功效设计，应该是面向任何开发工具和开发平台。所以，在需求文档中应该只描述出功效即可，而不应该绝对具体，以免限制设计人员针对具体开发工具物理实现设计和程序人员发挥； 在用例描述文档中对事件流、业务规则、公共业务规则、例外、扩充点、注释等内容引用，要进行链接，便于阅读。 用例事件流描述 用例文档中有三种事件流：基础事件流、子事件流、备选事件流，事件流编写基础要求以下： 事件流描写“实施者”和“系统”交互过程，通常不应该夹杂着业务规则和条件判定； 子事件流和备选事件流确实定：有事件流在一个用例文档中既作为子事件流出现，又作为备选事件流出现，此时没有必需把这一个事件流分别作为子事件流和备选事件流写成两个，而是以步骤实施或书写次序，在第一次使用这个事件流时它是子事件流，就将它放在子事件流章节中作为子事件流来书写；在第一次使用这个事件流时它是备选事件流，就将它放在备选事件流章节中作为备选事件流来书写； 界面流转在事件流中一定要说清楚；比如： 系统显示“选择查询战略”界面（CCA1