DB21 T 2139-2013 计算机软件工程文档编号规范.doc
《DB21 T 2139-2013 计算机软件工程文档编号规范.doc》由会员分享,可在线阅读,更多相关《DB21 T 2139-2013 计算机软件工程文档编号规范.doc(16页珍藏版)》请在麦多课文档分享上搜索。
1、 ICS 35.080 L70 DB21 辽 宁 省 地 方 标 准 DB XX/ XXXXX XXXX 计算机软件工程文档编号规范 Specification of computer software engineering documentation numbering (报批稿) 2013 - XX - XX 发布 2013 - XX - XX 实施 发布 DBXX/ XXXXX XXXX I 目 次 前言 . II 引言 . III 1 范围 . 1 2 规范性引用文件 . 1 3 术语和定义 . 1 3.1 文档 . 1 3.2 软件工程文档 . 1 4 文档编号基本规则 . 1 4
2、.1 文档编号字符 . 1 4.2 文档编号基本原则 . 1 4.3 文档编号一般要求 . 2 4.4 分类编号 . 2 4.5 隶属编号 . 2 5 软件工程 文档编号 . 2 5.1 软件工程文档编号组成结构 . 3 5.2 软件产品编号 . 3 5.3 软件工程过程编号 . 4 5.4 子系统、组件、模块文档编号 . 4 5.5 文档种类编号 . 6 5.6 文档序号 . 7 5.7 语种编号 . 7 6 软件工程文档编号存储与标注 . 8 6.1 软件工程文档格式 . 8 6.2 软件工程文档编号存储 . 8 6.3 软件工程文档编号标注 . 8 附录 A(资料性附录) 软件工程文档编
3、号示例 . 9 参考文献 . 12 DBXX/ XXXXX XXXX II 前 言 本标准依据 GB/T1.1 2009标准化工作导则 第 1部分:标准的结构与编写制定。 本标准由大连市经济和信息化委员会提出。 本标准由辽宁省经济和信息化委员会归口。 本标准起草单位:大连华信计算机技术股份有限公司、大连软件行业协会。 本标准主要起草人:刘宏 、张静、尹宏、郎庆斌、孙鹏 。 本标准于 2013年 xx月 xx日首次发布。 DBXX/ XXXXX XXXX III 引 言 本规范借鉴其他行业的设计文档编号规范,对计算机软件开发过程输出 的软件工程文档的编号提出一般性要求。 软件工程文档从使用的角度
4、上大致可分为开发方在开发过程中使用的软件工程文档和软件用户需要的用户文档两类。本标准适用于对在开发过程中使用的软件工程文档的编号管理。 使用者可根据实际情况对本标准进行适当的裁剪。供方应提供给需方的用户文档类型和编号,由软件的需方和供方在合同中规定。 DBXX/ XXXXX XXXX 1 计算机软件工程文档编号规范 1 范围 本规范规定了文档编号的通用要求,以及软件工程文档编号、软件工程文档编号的存储与标注要求。 2 规范性引用文件 下列文件中的条款通过本标准的引用而成为本部分的条款。凡 是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本部分,然而,鼓励使用本标准的
5、各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本部分。 GB/T 8566-2007 信息技术 软件生存周期过程 GB/T 8567-2006 计算机软件工程文档编制规范 GB/T 11457-2006 软件开发术语 3 术语和定义 GB/T 11457-2006 确立的以及以下术语和定义适用于本文件。 3.1 文档 docment 能供人或机器阅读的,一般具有永久性的一套数据 媒介和其中包含的信息(不管它们记录在什么媒体上)。 3.2 软件工程文档 Software engineering docment 在计算机软件开发过程中所形成、用以描述或规定软件产品必
6、要信息的有关技术文档。 4 文档编号基本规则 4.1 文档编号字符 文档编号一般可采用下列字符表示: 0 9 阿拉伯数字; A Z 拉丁字母( O、 I 除外); 短横线( -)、圆点()。 4.2 文档编号基本原则 a) 科学性:选择事物或概念的最稳定的本质属性或特征作为信息分类的基础和依据。 DBXX/ XXXXX XXXX 2 b) 系统性:将选定的事物、概念的属性或特征按一定排列顺序予以系统化, 并形成一个合理的科学分类体系。 c) 唯一性:一个编号只能唯一地标识一个分类对象。 d) 可延性:应设置收容类目,以便保证增加新的事物和概念时,不致打乱已建立的分类体系,同时,还应为下级信息管
7、理系统在原有基础上的延拓、细化创造条件。 e) 规范性:同一层级代码的编写格式必须统一。 4.3 文档编号一般要求 a) 每个产品、子系统、组件、模块的文档均应有独立的编号。 1) 采用表格时,表中每个产品、子系统、组件、模块都应标出独立的编号。 2) 同一产品、子系统、组件、模块的文档用数张纸印刷成纸介质文档时,各张纸介质文档应标注同一编号。 3) 同一文档使用两种 以上的存储介质时,每种存储介质中的文档都应标注同一编号。 4) 复用文档的编号应采用被复用文档的编号。 b) 文档的编号一般可采用分类编号或隶属编号。也可采用将分类编号与隶属编号混合组合方式进行编号。 c) 文档的编号应与企业计
8、算机辅助管理分类编号要求相协调。 4.4 分类编号 分类编号是按对象 (软件产品、子系统、组件、模块 )、功能、特性等的相似性,采用十进位分类法编号。 a) 编号的基本部分由分类号(大类)、特征号(中类)和识别号(小类)三部分组成,中间可以圆点或短横线分开,圆点在下方,短横线在中间。必要时可以在尾部加尾注号。 b) 大、中、 小类的编号按十进位分类编号法。每类的码位一般由 2 位数(如软件产品、子系统、组件、模块)组成。 表 1 分类 编号 码位的序列及其含义表 分类号(大类) 特征号(中类) 识别号(小类) 尾注号 校验号 软件工程文档按软件开发过程、类型等编号 软件产品、子系统、组件、模块
9、区分码位 软件工 程文 档按种类、编写语言等编号 软件工程文档、软件产品改进尾注号 检验软件产品代号的码位 c) 尾注号表示软件工程文档 、 软件 产品改进 。一般改进的尾注号用拉丁字母表示。 d) 用计算机自动生成软件产品文档编号时,应在编号终端加校验号(校验码)。 4.5 隶属编 号 隶属编号是按系统、组件、模块的隶属关系编号。 a) 编号由软件产品编号和隶属号组成。中间可用圆点或短横线隔开,必要时可加尾注号。 b) 需要时在首位前加分类号表示计算机辅助管理信息分类编号系统的大类号。 c) 系统编号由字母和数字组成。 d) 隶属号由数字组成,其级数和位数应按软件产品结构的复杂程度而定。 e
10、) 组件的序号,应在其所属(系统或上一级组件)的范围内编号。 f) 模块的序号,应在其所属(系统或组件)的范围内编号。 DBXX/ XXXXX XXXX 3 g) 编流水号时,可在尾部以带“ 0”或不带“ 0”区别模块与组件。 5 软件工程文档编号 5.1 软件工程文档编号组成结构 软件工程文 档编号应由 8部分组成。各部分位数如下: a) 软件产品编号( 3 位) b) 工程过程编号( 2 位) c) 子系统编号( 2 位) d) 组件编号( 2 位) e) 模块编号( 2 位) f) 文档种类编号( 2 位) g) 文档序号( 2 位) h) 语种编号( 2 位) 软件工程文档编号采用分类
11、编号与隶属编号混合组合方式。其中工程过程编号、文档种类编号、语种编号应采用分类编号;软件产品编号、子系统编号、组件编号、模块编号是采用隶属编号。软件工程文档编号组成结构参见图 1。 图 1 软件工程文档编号组成图 5.2 软件产品编号 软件产品编号 应满足如下要求: a) 软件产品编号应由 3 位英文大写字母或 3 为数字组成。 软件产品编号( 3 位) 工程过程编号( 2 位) 子系统编号( 2 位) 组件编号( 2 位) 模块编号( 2 位) 文档种类编号( 2 位) 语言种类编号( 2 位) 文档序号( 2 位) DBXX/ XXXXX XXXX 4 b) 当软件产品编号为英文缩写时,表
12、示该软件为软件产品或软件包。 3 位大写字母应该为软件产品英文缩写。软件产品编号示例,参见表 2 软件产品编号表。 表 2 软件产品编号表 软件产品名称 软件产品编号 英文 数字编号 英文缩写编号 A 系统 001 SSA System B 系统 002 SSB System C 系统 003 SSC System c) 当软件产品编号为数字时,表示在软件产品基础上为客户定制的系统。 3 为数字应客户代码,不足 3 位,用“ 0” 从右侧补足 3 位。为客户定制系统编号 示例 ,参见表 3。 表 3 客户定制系统编号表 客户名称 软件产品编号 演示系统 000 A 客户 100 B 客户 20
13、0 B 客户的 B1 子公司 210 5.3 软件工程过程 编号 软件工程过程编号应满足如下要求: a) 软件工程过程编号应由 2 位大写的英文字母或数字组成。大写的英文字母是软件工程过程的英文名称缩写。软件工程过程的编号示例,参见表 4。 表 4 软件工程过程编号表 软件工程过程名称 软件工程过程编号 英文名称 数字编号 英文缩写编号 业务分析 01 BA Business Analysis 需求开发 02 RD Requirement Development 概要设计 03 BD Basic Design 详细设计 04 DD Detail Design 编码 05 CD Coding 单
14、体测试 06 UT Unit Testing 集成测试 07 TT Integration Testing 系统测试 08 ST System Testing 实施交付 09 AD Application Delivery 运行维护 10 PM Operations & Maintenance b) 软件工程文档在多个软件开发过程中共同进行修改与更新时,软件开发过程文档编号可省略。 c) 在软件开发中,不区分软件开发过程时,软件开发过程文档编号可省略。 5.4 子系统、组件、模块文档编号 子系统、组件、模块文档编号应满足如下要求: DBXX/ XXXXX XXXX 5 a) 子系统、组件、模块
- 1.请仔细阅读文档,确保文档完整性,对于不预览、不比对内容而直接下载带来的问题本站不予受理。
- 2.下载的文档,不会出现我们的网址水印。
- 3、该文档所得收入(下载+内容+预览)归上传者、原创作者;如果您是本文档原作者,请点此认领!既往收益都归您。
本资源只提供5页预览,全部文档请下载后查看!喜欢就下载吧,查找使用更方便
5000 积分 0人已下载
下载 | 加入VIP,交流精品资源 |
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- DB21 2139 2013 计算机 软件工程 文档 编号 规范
