DB21 T 2139-2013 计算机软件工程文档编号规范.doc

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) 子系统、组件、模块

15、文档编号应由软件产品编号加各层顺序号组成。 b) 分文档最多不超过 5 层。 c) 每层文档的编号方法应统一，编号应连续。 d) 第 5 层的模块文档采用并列顺序编号，必要时也可以从第 4 层、第 3 层或第 2 层开始采用并列顺序号方法。 e) 当本层级顺序号为 00 时，表示此文档是本层级的公共子系 统、组件、模块的软件工程文档。 f) 当下一层级顺序为 00 时，表示存在下一层级分文档。当无下一层级编号时，表示不存在下一层级分文档。 子系统、组件、模块文档编号示例，参见图 2。 DBXX/ XXXXX XXXX 6 图 2 子系统、组件、模块文档编号示意图 5.5 文档种类编号 SSA-

16、0100 子系统 1 SSA-0200 子系统 SSA-00 系统 SSA-020000 公共组件 SSA-020100 组件 SSA-02010200 模块 SSA-0300 子系统 SSA-000100 公共组件 SSA-000101 公共模块 SSA-010100 组件 SSA-000102 公共模块 SSA-010001 公共模块 SSA-010000 公共组件 SSA-010101 模块 SSA-010102 模块 SSA-020001 公共模块 SSA-020101 模块 SSA-030000 公共组件 SSA-030001 模块 SSA-030100 组件 SSA-0301010

17、0 组件 SSA-03010101 模块 SSA-03010102 模块 第 0 层 第 1 层 第 2 层 第 3 层 第 4 层 SSA-0000 公共子系统 SSA-000200 公共组件 SSA-000201 公共模块 SSA-000202 公共模块 DBXX/ XXXXX XXXX 7 文档种类编号应满足如下要求： a) 文档种类编号由 2 位大写的英文字母或数字组成。大写的英文字母是文档种类的英文名称缩写。文档种类编号示例，参见表 5。 b) 当文档种类名称为“功能定义”时，文档种类编号可省略。 表 5 文档种类编号表 文档种类名称 文档 种类编号 英文 数字编号 英文缩写编号 产

18、品介绍 01 PT Product Introduction 产品方案 02 SL Product Solution 流程图 03 WF Work Flow 组织结构 04 RS Organizational Structure Chart 实体关系 05 ER Entity Relation Chart 功能定义 06 FD Function Define 产品需求定义 07 PD Product Requirement Define 数据字 典 08 DD Data Dictionary 架构模型 09 AM Architecture Model CRUD 矩阵 10 CM CRUD Ma

19、trix 需求与变更 11 RC Requirement and Change 确认报告 13 VR Validation Report 用户界面 14 UF User Interface 测试用例 17 TC Testing Case 测试报告 18 TR Testing Report 检查单 19 CL Check List 评估报告 20 AR Assessment Report 培训 21 TR Training 缺陷 22 DF Defect 评审 23 RW Review 需求跟踪矩阵 24 RT Requment Tracing Matrix 词语表 25 TT Terminol

20、ogy Table 产品介绍 01 PT Product Introduction 产品方案 02 SL Product Solution 5.6 文档序号 文档序号编号应满足如下要求： a) 文档序号编号由 2 为数字组成。不足 2 两位，左侧用“ 0”补足。 b) 当 相同的子系统、组件或模块，且相同文档种类存在多个文档时，使用文档序号进行编号区分。 c) 当只有一份文档时，文档序号可省略。 5.7 语种编号 a) 语种编号应满足如下要求： b) 语种编号为 2 位英文大写字母或数字组成。 DBXX/ XXXXX XXXX 8 c) 大写的英文字母是语言的英文名称缩写。 d) 当语言种类为

21、“中文”时，可省略。 常用语种编号示例，参见表 6 语种编号表。 表 6 语种编号表 文档语言名称 文档语种编号 英文 数字编号 英文缩写编号 中文 01 CN China 英文 02 EN English 日文 03 JP Japanese 德语 04 GN German 6 软件工程文档编号存储与标注 6.1 软件工程文档格式 软件工程文档格式为办公软件的兼容格式，文档用于发布可以采用 PDF格式。 6.2 软件工程文档编号存储 在 OFFICE的兼容格式文件中，软件工程文档编号存放在文件的“属性”的自定义项目的“文档编号”字段中。当一个文件中存在多个文档时，存放软件开发主文档编号。 6.

22、3 软件工程文档编号标注 在每个文档的封面应标注文档编号。 在电子表格类（如： XLS）文档中，在表头部分标注文档编号。 在文字类（如： DOC）文档中，在页眉或页脚中标注文档编号。 DBXX/ XXXXX XXXX 9 A A 附 录 A （资料性附录） 软件工程文档编号示例 A.1 示例说明 以 A软件产品的 01子系统为例，说明软件各类文档编号。 所有文档使用中文编写。 示例中的各种文档在软件开发中只是典型的文档，并不代表软件开发中全部种类文档。 A.2 共同文档 01子系统共同文档编号示例如下： 文档名称 文档编号（英文缩写） 文档种类 01 子系统数据字典 SSA-01-DD 数据字

23、典 01 子系统的需求跟踪矩阵表 SSA-01-TT 词语表 01 子系统的词语表 SSA-01-RT 需求跟踪矩阵表 01 子系统的缺陷记录 (第 1 个 ) SSA-01-DF01 缺陷记录 A.3 业务分析过程 01子系统的业务分析文档编号示例如下： 文档名称 文档编号 文档种类 01 子系统业务介绍 SSA-BA01-PT 介绍 01 子系统业务方案 SSA-BA01-SL 方案 01 子系统业务流程图 SSA-BA01-WF 流程图 01 子系统业务相关的组织结构图 SSA-BA01-RS 组织结构图 01 子系统数据概念模型 SSA-BA01-ER 实体关系图 01 子系统业务功能

24、总体说明 SSA-BA0100-FD 功能定义 01 子系统业务功能组件 01 说明 SSA-BA0101-FD 功能定 义 01 子系统业务总体架构图 SSA-BA01-AM 架构图 01 子系统业务功能与数据实体 CRUD 矩阵表 SSA-BA01-CM CRUD 矩阵 01 子系统业务分析确认单 (第 1 个 ) SSA-BA01-VR01 确认报告 01 子系统业务分析文档评审检查单 (第 1 个 ) SSA-BA01-CL01 检查单 01 子系统业务分析评估报告 (第 1 个 ) SSA-BA01-AR01 评估报告 01 子系统业务分析评审记录表 (第 1 个 ) SSA-BA0

25、1-RW01 评审记录 01 子系统业务的培训资料 (第 1 个 ) SSA-BA01-TR01 培训 A.4 需求定义过程 DBXX/ XXXXX XXXX 10 01子系统的功能需求定义文档编号示例如下： 文档名称 文档编号 文档种类 01 子系统的系统功能介绍文档 SSA-RD01-PT 介绍 01 子系统功能流程图 SSA-RD01-WF 流程图 01 子系统相关角色组织结构图 SSA-RD01-RS 组织结构图 01 子系统的数据逻辑模型 SSA-RD01-ER 实体关系图 01 子系统功能需求总体说明 SSA-RD0100-FD 功能定义 01 子系统功能需求组件 01 说明 SS

26、A-RD0101-FD 功能定义 01 子 系统总体结构图 SSA-RD01-AM 架构图 01 子系统 CRUD 矩阵表 SSA-RD01-CM CRUD 矩阵 01 子系统需求变更票 (第 1 个 ) SSA-RD01-RC01 需求与变更票 01 子系统用户界面 (第 1 个 ) SSA-RD01-UF01 用户界面 01 子系统评审检查单 (第 1 个 ) SSA-RD01-CL01 检查单 01 子系统需求定义评审记录表 (第 1 个 ) SSA-RD01-RW01 评审记录 01 子系统评估报告 (第 1 个 ) SSA-RD01-AR01 评估报告 A.5 设计过程 A子系统的设

27、计文档编 号示例如下： 文档名称 文档编号 文档种类 01 子系统处理模块流程图 SSA-BD01-WF 流程图 01 子系统的数据物理模型 SSA-BD01-ER 实体关系图 01 子系统设计总体说明 SSA-BD0100-FD 功能定义 01 子系统 01 组件设计说明 SSA-BD0101-FD 功能定义 01 子系统设计架构图 SSA-BD01-AM 架构图 01 子系统设计 CRUD 矩阵表 SSA-BD01-CM CRUD 矩阵 01 子系统设计确认票 (第 1 个 ) SSA-BD01-VR01 确认报告 01 子系统集 成测试用例 (第 1 个 ) SSA-TT01-TC01

28、测试用例 01 子系统设计评审检查单 SSA-BD01-CL 检查单 01 子系统设计评估报告 SSA-BD01-AR 评估报告 01 子系统设计评审记录表 (第 1 个 ) SSA-BD01-RW01 评审记录 A.6 系统测试过程 A子系统的系统测试文档编号示例如下： 文档名称 文档编号 文档种类 01 子系统的系统测试介绍文档 SSA-ST01-PT 介绍 01 子系统的系统测试方案文档 SSA-ST01-SL 方案 01 子系统的系统测试用例总体说明文档 SSA-ST0100-FD 功能定义 01 子系统的 01 组件系统测试用例说明文档 SSA-ST0101-FD 功能定义 01 子

29、系统的系统测试评审检查单 (第 1 个 ) SSA-ST01-CL01 检查单 DBXX/ XXXXX XXXX 11 文档名称 文档编号 文档种类 01 子系统的系统测试评估报告 SSA-ST01-AR 系统测试评估报告 01 子系统的系统测试评审记录表 (第 1 个 ) SSA-ST01-RW01 评审记录 DBXX/ XXXXX XXXX 12 参 考 文 献 1 GB/T 8566-2007 信息技术 软件生存周期过程 2 GB/T 8567-2006 计算机软件工程文档编制规范 3 GB/T 16680-1996 软件工程文档管理指南 4 GB/T 20158-2006 信息技术 软件生存周期过程 配置管理 5 GB/T 19000-2008 质量管理体系 基础和术语 6 GB/T 7027-2002 信息分类和编号的基本原则与方法 6 GB/T 10113 分类编号通用术语 7 GB/T 17710 数据处理 校验码系统 _