应用系统命名规范
文档编号:
青岛高校信息产业有限公司
[注:用方括号括起来并以蓝斜体显示的文本,它们用于向使用者提供指导,在发布此文档之前应该将其删除。黑体正体显示的文本为预先设置好的文本,可直接使用或修改]
[要定制 Microsoft Word 中的自动字段(选中时显示灰背景),请选择 File>Properties,然后将 Title、Subject 和 Company 等字段替换为此文档的相应信息。关闭该对话框后,通过选择 Edit>Select All(或 Ctrl-A)并按 F9,或只是在字段上单击并按 F9,可以在整个文档中更新自动字段。对于页眉和页脚,这一操作必须单独进行。按 Alt-F9,将在显示字段名称和字段内容之间切换。有关字段处理的详细信息,请参见 Word 帮助。]
修订文档历史记录
版本号 | 变更报告编号 | 更改条款及内容 | 更改人 | 审批人 | 更改日期 |
jsp中文全称 | |||||
[评审确认后的版本为1.0,每一扩展新功能规模,版本升1.0,每一变更有一变更报告,带来版本0.1的升级,]]
1.文档概述
1.1目的
此组准则的目的是确保应用系统命名的一致性和可追踪性,这些准则可以按原样使用,或者进行部分定制,以满足大部分项目的需求。
1.2目标读者
系统分析员、系统设计员、项目经理、质量管理员、开发人员
plight1.3术语与缩略
术语名称 | 术语描述 | 备注 unix操作系统是当今流行的一种多用户什么操作系统 |
EOS | 上海普元公司提供的面向构件的中间件平台,作为本项目应用软件的技术平台 | |
构件 | 本规范所提到的构件及构件包的概念,均指EOS中的构件与构件包。 | |
后端开发现状FBFRAME | 基础业务框架 | |
1.4参考资料
1.《EOS项目开发规范》.doc
2. RUP 2005
2.文档规范
◆文档命名规范:系统全称+中文文档名。如:《财富管理系统概要设计说明书.doc》
◆文档编写要求:
●类风湿关节炎是怎么形成的Word XP(项目组必须统一文档工具的版本)
●所绘图形要求提供原始文件
●在Word中的插图尽可能使用JPG格式,以降低WORD文档的大小
●文档一旦初步定稿之后,评审者采用修正模式修改文档
3.软件需求规范
3.1功能分解层次约束
《软件需求规格说明书》中的功能被组织为两级,分别对应于子系统(主题)和对应于子系统的功能(UC),如子系统内功能太多具有多层特征时,可通过进一步分解降低为两层,划分的依据是统一的,如在依据业务流程的工作单元划分或依据用户类别划分;
3.2需求子系统命名
一项目可包含多个子系统,每一子系统以中文全称分别命名。
3.3需求功能模块命名规范
子系统下的功能模块(软件需求采用用例模型,对应用例名称)的命名采取格式为:动词+名词的方式,如系维护电话卡
3.4需求功能描述
此描述的长度至少应当为 1 个段落,并且不超出 3 个段落。描述中需包含功能的关键目的、价值陈述和概念的说明,可以详细说明功能点。
4.系统分析设计
4.1统一英文缩写或名词约定列表
本项目中,无论数据库设计、程序文件命名、文档文件命名,对于同一概念,如果需要使用缩写,统一使用如下定义。
词语/缩写 | 英文描述 | 中文描述 |
EOS | 普元面向构件中间件平台 | |
Doc | Document | 文档 |
Src | Source Code | 源码 |
Feature | Feature | 功能点,指经过设计后分解的功能 |
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业务字典功能,为系统实现提供的大量构件,方便开发。 | |
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论