2应用系统命名指南.docVIP

基于EOS平台 开发应用系统命名规范 版本 1.0 ? 青岛大学信息工程学院 修订历史 日期 版本 描述 作者 ? 2009-02-08 ? ? 草案 ? ? ? ? ? ? 目录 1. 简介 1.1 目的 1.2 范围 1.3 定义、首字母缩写和缩写 1.4 参考资料 1.5 概述 2. 一般用例建模准则 2.1 一般风格 2.2 通信 关系的使用 2.3 包含 和 扩展 关系的使用。 2.3.1 包含 关系的使用。 2.3.2 扩展 关系的使用。 2.4 参与者泛化关系的使用 2.5 交互图的使用 2.6 活动图的使用 3. 如何描述用例 3.1 参与者准则 3.1.1 每个具体用例至少涉及一个参与者 3.1.2 直观、描述性的参与者名称 3.1.3 参与者名称的一致使用 3.2 用例名称 3.3 用例简短描述 3.3.1 至少 1 个段落 3.3.2 示例（可选） 3.4 祈使语气的一致使用：需要 3.5 词汇表术语的使用 3.6 “操作”术语的使用 3.6.1 定义系统负责在何处提供操作选项 3.6.2 术语在整个用例中的一致使用 3.7 参与者和系统行为的独立段落 3.8 备选流和子流 3.9 前置条件和后置条件 3.10 对于缺少的详细信息使用占位符（待定） 3.11 补充规范的定义和引用 3.12 使用 UI 原型／设计进行交叉检查 3.13 异常流（可选） 3.13.1 发生什么异常？ 1.????????????????? 简介? 1.1?????????????? 目的 此组准则的目的是确保的一致性。 1.2?????????????? 范围 这些准则可以按原样使用，或者进行定制，以满足大部分项目的需求。 1.3?????????????? 定义、首字母缩写和缩写 EOS： 上海普元公司提供的面向构件的中间件平台，作为本项目应用软件的技术平台 构件： 本规范所提到的构件及构件包的概念，均指EOS中的构件与构件包。 FBFRAME： 基础业务框架 1.4?????????????? 参考资料 《EOS项目开发规范》.doc 2.????????????????? 系统的描述 一项目可包含多个子系统，为了区分出各个子系统课分别命名，名称为中文全称名称加附在括号内的3个小写字母表示的缩写名称。缩写名称，主要用于在构件名称中标识构件包和数据库表命名，对应于用例模型中的包。如： 财富管理系统（wms） 资金管理系统（cms） 定价管理系统（pms） 3.????????????????? 统一英文缩写或名词约定列表 本项目中，无论数据库设计、程序文件命名、文档文件命名，对于同一概念，如果需要使用缩写，统一使用如下定义。 词语/缩写 英文描述 中文描述 EOS 普元面向构件中间件平台 Doc Document 文档 Src Source Code 源码 Fea Feature 功能点，指经过设计后分解的功能 Req Requirement 需求点，指需求调研后形成的用户需求 Query 查询，在定义程序文件名称时，“查询”功能使用的英文为Query，例如AccountQuery.jsp Add 增加，在定义程序文件名称时，“增加”功能使用的英文名称为”Add”，例如AccountAdd.jsp Update 编辑，在定义程序文件名称时，“修改”功能使用的英文名称为“Update”，例如AccountUpdate.jsp Delete Delete 删除，在定义程序文件名称时，“删除”功能使用的英文名称为“Delete”，例如Account Delete.jsp List 结果列表使用英文名称，例如AccountList.jsp Return Return 返回，系统中表示返回的英文缩写 Success 系统中表示成功的英文单词均使用Success Fault 系统中表示失败的英文单词均使用Fault Error Error 系统中表示错误的英文缩写 业务字典 系统中与业务相关的代码及对代码的描述，例如，用Authlevel表示用户认证等级，而0：所有用户，1：登录用户，2：产品绑定用户等。 EOS提供了对业务字典的管理，通过EOS业务字典功能，为系统实现提供的大量构件，方便开发。 开发目录编排与命名 文档目录 遵循RUP的组织方式，强制配置。 文档规范 文档命名规范：系统全称+“_”+中文文档名。如：《财富管理系统（WMS）概要设计说明书.doc》 文档编写要求： Word XP（项目组必须统一文档工