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

ERP 项目 需求分析规范 用例描述文档编写规范（精要） 版本 1.0 文档编号：001-0002-2 企业机密 启明公司, 2006 ERP 项目组 版本历史 日期 版 描述 作者 本 2006-07-01 1. 初稿整理 吕春秋 0 企业机密 启明公司, 2003 Page 2 of 30 目 录 企业机密 启明公司, 2003 Page 3 of 30 企业机密 启明公司, 2003 Page 4 of 30 企业机密 启明公司, 2003 Page 5 of 30 用例描述文档编写规范（精要） 1. 前言 1.1 目的 本用例描述文档编写精要对新一代 ERP 项目组几年来用例设计经验进行 总结，广泛吸收各方长处，分析编写过程中出现的弊端，整理出了这些编写用 例文档需要掌握的要点，为指导今后需求设计、需求更改过程中文档编写起到 规范的作用，不足，发现优点。 要不断地充实和完善。提高用例编写水平， 1.2 范围 本“用例描述文档编写精要”作为一个规范性的文件，适用于新一代 ERP 项目组需求分析与设计过程中的用例描述文档的设计工作。 1.3 本文档说明 采用说明与案例相结合的方式进行描述，便于理解。 本文档描述的内容相对比较多，每次应用时都通篇阅读比较费时。为了重 点突出，文档描述中带“双下浪线”的文字都是当前章节的要点内容，便于概览 阅读。 企业机密 启明公司, 2003 Page 6 of 30 为了问题说明重点突出，所有例子都是化简之后的实例，不能认为例子与 原用例的不一致就是用例错误或例子错误。 新一代 ERP 项目的需求规范是在开发过程中不断总结和完善的，因此， 本“用例描述文档编写精要” 同样需要逐步完善的过程，如果发现文档存在问 题，发现需求设计工作存在问题，或者有好的建议，或者有不同见解，请及时 与需求主管联系，诚谢。 企业机密 启明公司, 2003 Page 7 of 30 系统的效率 2. 基本要求 对于用例描述文档的书写（需求设计），不同部分会有不同的要求，但是从 整体上来讲应该遵循以下几项原则： 1、 要从开发者的角度完善文档的可读性及处理性能； 2、 要站在客户的角度考虑程序的可操作性 3、 用例所用的表结构要和 ROSE 中的业务类图保持一致，用例 中使用的类属性描述；