应用系统命名标准规范Word文档格式.docx

应用系统命名标准规范Word文档格式.docx

《应用系统命名标准规范Word文档格式.docx》由会员分享，可在线阅读，更多相关《应用系统命名标准规范Word文档格式.docx（10页珍藏版）》请在冰豆网上搜索。

变更报告编号

更改条款及内容

更改人

审批人

更改日期

[评审确认后版本为1.0，每一扩展新功能规模，版本升1.0，每一变更有一变更报告，带来版本0.1升级，]]

4.7数据库设计命名规范6

1.文档概述

1.1目

此组准则目是保证应用系统命名一致性和可追踪性，这些准则可以按原样使用，或者进行某些定制，以满足大某些项目需求。

1.2目的读者

系统分析员、系统设计员、项目经理、质量管理员、开发人员

1.3术语与缩略

术语名称

术语描述

备注

EOS

上海普元公司提供面向构件中间件平台，作为本项目应用软件技术平台

构件

本规范所提到构件及构件包概念，均指EOS中构件与构件包。

FBFRAME

基本业务框架

1.4参照资料

1.《EOS项目开发规范》.doc

2.RUP

2.文档规范

◆文档命名规范：

系统全称+中文文档名。

如：

《财富管理系统概要设计阐明书.doc》

◆文档编写规定：

●WordXP（项目组必要统一文档工具版本）

●所绘图形规定提供原始文献

●在Word中插图尽量使用JPG格式，以减少WORD文档大小

●文档一旦初步定稿之后，评审者采用修正模式修改文档

3.软件需求规范

3.1功能分解层次约束

《软件需求规格阐明书》中功能被组织为两级，分别相应于子系统（主题）和相应于子系统功能（UC），如子系统内功能太多具备多层特性时，可通过进一步分解减少为两层，划分根据是统一，如在根据业务流程工作单元划分或根据顾客类别划分；

3.2需求子系统命名

一项目可包括各种子系统，每一子系统以中文全称分别命名。

3.3需求功能模块命名规范

子系统下功能模块（软件需求采用用例模型，相应用例名称）命名采用格式为：

动词+名词方式，如系维护电话卡

3.4需求功能描述

此描述长度至少应当为1个段落，并且不超过3个段落。

描述中需包括功能核心目、价值陈述和概念阐明，可以详细阐明功能点。

4.系统分析设计

4.1统一英文缩写或名词商定列表

本项目中，无论数据库设计、程序文献命名、文档文献命名，对于同一概念，如果需要使用缩写，统一使用如下定义。

词语/缩写

英文描述

中文描述

普元面向构件中间件平台

Doc

Document

文档

Src

SourceCode

源码

Feature

功能点，指通过设计后分解功能

Query

查询，在定义程序文献名称时，“查询”功能使用英文为Query，例如AccountQuery.jsp

Add

增长，在定义程序文献名称时，“增长”功能使用英文名称为”Add”，例如AccountAdd.jsp

Update

编辑，在定义程序文献名称时，“修改”功能使用英文名称为“Update”，例如AccountUpdate.jsp

Delete

删除，在定义程序文献名称时，“删除”功能使用英文名称为“Delete”，例如AccountDelete.jsp

List

成果列表使用英文名称，例如AccountList.jsp

Return

返回，系统中表达返回英文缩写

Success

系统中表达到功英文单词均使用Success

Fault

系统中表达失败英文单词均使用Fault

Error

系统中表达错误英文缩写

业务字典

系统中与业务有关代码及对代码描述，例如，用Authlevel表达顾客认证级别，而0：

所有顾客，1：

登录顾客，2：

产品绑定顾客等。

EOS提供了对业务字典管理，通过EOS业务字典功能，为系统实现提供大量构件，以便开发。

4.2设计子系统命名

设计子系统是《软件需求规格阐明书》中子系统在设计模型中映射，也许有扩展或调节，为了区别出各个子系统应分别命名，名称为中文全称名称加附在括号内3个小写字母表达缩写名称。

缩写名称，重要用于在构件名称中标记构件包和数据库表命名，如使用用例建模，子系统相应于用例模型中包，应在包中表白缩写。

资金管理（cms）

定价管理（pms）

仓储管理（wms）

4.3设计功能模块命名规范

设计中功能模块命名为英文，方式为：

系统缩写名称+“_”+若干英文单词构成业务描述，名称单词第一种字母用大写别的使用英文小写。

功能模块（用例）定义与EOS构件包命名一致，如：

子系统

功能模块（UC）

设计命名

维护电话卡

wms_MaintainPhoneCard

出电话卡

wms_OutPhoneCard

4.4子系统功能跟踪规范

每一设计子系统下建立一用例实现图，命名为Main，建立本子系统下功能实现与功能需求间追踪关系，如wms_MaintainPhoneCard（设计阶段）---〉维护电话卡（需求阶段）；

每一设计子系统下建立一类图，命名为Main，建立本子系统下所有功能所涉及实体及逻辑关系。

4.5类、实体命名

●类、实体命名采用全拼英文，每词命名采用首写字母大写别的字母小写方式，命名需要两词或以上，词间持续不要在对象名称字符之间留空格，如PhoneCard，类名建议不要太长（12个字符以内），如果太长，使用单词缩写，（CamelCase法，但首字母为大写）

●对象名称不能使用中文，不能使用中文拼音或中文拼音首字母，尽量不使用阿拉伯数字

●必要保证名称没有和保存词、数据库系统或者惯用访问办法冲突

4.6功能模块设计规范

每一功能模块下建立一类图，命名为Main，建立本功能模块所涉及界面类、实体类及逻辑关系；

每一功能模块下建立一或各种流程图，描述解决逻辑，图命名反映要解决任务；

4.7数据库设计命名规范

表命名规范

表名为大写字母构成：

系统缩写+_+对象名称（相应类、实体命名，改为大写）+大写数据库对象后缀，例如业务原则系统某个表名：

WMS_PHONECARD_TD，下为命名规格阐明：

对象名称

对象类别

命名规则（加前缀）

表

业务数据表

WMS_对象名_TD

代码表

WMS_对象名_TC

关联表

WMS_对象名_TJ

系统定义表

WMS_对象名_TS

键和索引

主键

WMS_对象名_PK

外键

WMS_对象名_FK

索引

WMS_对象名_IX

视图

WMS_对象名_VIEW

包

WMS_对象名_PACK

存储过程

WMS_对象名_PROC

函数

WMS_对象名_FUNC

触发器

WMS_对象名_TRI

字段命名规范

●采用大写字母命名；

●不同表同一种业务字段类型、长度、字段名称保持统一，例如，客户编号也许存在于各种表中，规定采用同样字段名，并且类型、长度一致

●字段名建议不要太长（15个字符以内），如果太长，请使用单词缩写

数据库设计规范

●必要满足三个数据库设计范式

●保证数据完整性使用事务提交概念、使用触发器等手段、设立外键

●数据库维护（整顿，备份，恢复）

●数据库访问操作必要考虑网络多顾客使用冲突问题

●对较大系统，需要考虑数据安全性，数据分布，数据复制，数据仓库等等

●必要考虑数据库访问速度，对于数据量较大表，一定要加索引

5.系统实行

Eos数据构件目录命名

●项目名使用项目简称

●一项目建立一种数据库管理构件包，命名为：

项目简称+“_”+DATA

●以子系统简称命名子系统数据构件，其下包括本子系统所有数据库表

开发目录命名

应用功能构件包前缀辨认所属子系统；

构建包命名根据《功能分解矩阵》或系统分析设计模型。