DB21T 2139计算机软件工程文档编号规范Word文档格式.docx
《DB21T 2139计算机软件工程文档编号规范Word文档格式.docx》由会员分享，可在线阅读，更多相关《DB21T 2139计算机软件工程文档编号规范Word文档格式.docx（16页珍藏版）》请在冰豆网上搜索。
A～Z拉丁字母（O、I除外）；
短横线（-）、圆点（•）。
文档编号差不多原则
科学性：
选择事物或概念的最稳固的本质属性或特点作为信息分类的基础和依据。
系统性：
将选定的事物、概念的属性或特点按一定排列顺序予以系统化，并形成一个合理的科学分类体系。
唯独性：
一个编号只能唯独地标识一个分类对象。
可延性：
应当设置收容类目，以便保证增加新的事物和概念时，不致打乱已建立的分类体系，同时，还应为下级信息治理系统在原有基础上的延拓、细化制造条件。
规范性：
同一层级代码的编写格式必须统一。
文档编号一样要求
每个产品、子系统、组件、模块的文档均应有独立的编号。
采纳表格时，表中每个产品、子系统、组件、模块都应标出独立的编号。
同一产品、子系统、组件、模块的文档用数张纸印刷成纸介质文档时，各张纸介质文档应标注同一编号。
同一文档使用两种以上的储备介质时，每种储备介质中的文档都应标注同一编号。
复用文档的编号应采纳被复用文档的编号。
文档的编号一样可采纳分类编号或隶属编号。
也可采纳将分类编号与隶属编号混合组合方式进行编号。
文档的编号应与企业运算机辅助治理分类编号要求相和谐。
分类编号
分类编号是按对象（软件产品、子系统、组件、模块）、功能、特性等的相似性，采纳十进位分类法编号。
编号的差不多部分由分类号（大类）、特点号（中类）和识别号（小类）三部分组成，中间能够圆点或短横线分开，圆点在下方，短横线在中间。
必要时能够在尾部加尾注号。
大、中、小类的编号按十进位分类编号法。
每类的码位一样由2位数（如软件产品、子系统、组件、模块）组成。
分类编号码位的序列及其含义表
分类号（大类）
特点号（中类）
识别号（小类）
尾注号
校验号
软件工程文档按软件开发过程、类型等编号
软件产品、子系统、组件、模块区分码位
软件工程文档按种类、编写语言等编号
软件工程文档、软件产品改进尾注号
检验软件产品代号的码位
尾注号表示软件工程文档、软件产品改进。
一样改进的尾注号用拉丁字母表示。
用运算机自动生成软件产品文档编号时，应在编号终端加校验号（校验码）。
隶属编号
隶属编号是按系统、组件、模块的隶属关系编号。
编号由软件产品编号和隶属号组成。
中间可用圆点或短横线隔开，必要时可加尾注号。
需要时在首位前加分类号表示运算机辅助治理信息分类编号系统的大类号。
系统编号由字母和数字组成。
隶属号由数字组成，其级数和位数应按软件产品结构的复杂程度而定。
组件的序号，应在其所属（系统或上一级组件）的范畴内编号。
模块的序号，应在其所属（系统或组件）的范畴内编号。
编流水号时，可在尾部以带“0”或不带“0”区别模块与组件。
软件工程文档编号
软件工程文档编号组成结构
软件工程文档编号应由8部分组成。
各部分位数如下：
软件产品编号（3位）
工程过程编号（2位）
子系统编号（2位）
组件编号（2位）
模块编号（2位）
文档种类编号（2位）
文档序号（2位）
语种编号（2位）
软件工程文档编号采纳分类编号与隶属编号混合组合方式。
其中工程过程编号、文档种类编号、语种编号应采纳分类编号；
软件产品编号、子系统编号、组件编号、模块编号是采纳隶属编号。
软件工程文档编号组成结构参见图1。
软件工程文档编号组成图
软件产品编号
软件产品编号应满足如下要求：
软件产品编号应由3位英文大写字母或3为数字组成。
当软件产品编号为英文缩写时，表示该软件为软件产品或软件包。
3位大写字母应该为软件产品英文缩写。
软件产品编号示例，参见表2软件产品编号表。
软件产品编号表
软件产品名称
英文
数字编号
英文缩写编号
A系统
001
SSA
System
B系统
002
SSB
C系统
003
SSC
当软件产品编号为数字时，表示在软件产品基础上为客户定制的系统。
3为数字应客户代码，不足3位，用“0”从右侧补足3位。
为客户定制系统编号示例，参见表3。
客户定制系统编号表
客户名称
演示系统
000
A客户
100
B客户
200
B客户的B1子公司
210
软件工程过程编号
软件工程过程编号应满足如下要求：
软件工程过程编号应由2位大写的英文字母或数字组成。
大写的英文字母是软件工程过程的英文名称缩写。
软件工程过程的编号示例，参见表4。
软件工程过程编号表
软件工程过程名称
英文名称
业务分析
01
BA
BusinessAnalysis
需求开发
02
RD
RequirementDevelopment
概要设计
03
BD
BasicDesign
详细设计
04
DD
DetailDesign
编码
05
CD
Coding
单体测试
06
UT
UnitTesting
集成测试
07
TT
IntegrationTesting
系统测试
08
ST
SystemTesting
实施交付
09
AD
ApplicationDelivery
运行爱护
10
PM
Operations&
Maintenance
软件工程文档在多个软件开发过程中共同进行修改与更新时，软件开发过程文档编号可省略。
在软件开发中，不区分软件开发过程时，软件开发过程文档编号可省略。
子系统、组件、模块文档编号
子系统、组件、模块文档编号应满足如下要求：
子系统、组件、模块文档编号应由软件产品编号加各层顺序号组成。
分文档最多不超过5层。
每层文档的编号方法应统一，编号应连续。
第5层的模块文档采纳并列顺序编号，必要时也能够从第4层、第3层或第2层开始采纳并列顺序号方法。
当本层级顺序号为00时，表示此文档是本层级的公共子系统、组件、模块的软件工程文档。
当下一层级顺序为00时，表示存在下一层级分文档。
当无下一层级编号时，表示不存在下一层级分文档。
子系统、组件、模块文档编号示例，参见图2。
子系统、组件、模块文档编号示意图
文档种类编号
文档种类编号应满足如下要求：
文档种类编号由2位大写的英文字母或数字组成。
大写的英文字母是文档种类的英文名称缩写。
文档种类编号示例，参见表5。
当文档种类名称为“功能定义”时，文档种类编号可省略。
文档种类编号表
文档种类名称
产品介绍
PT
ProductIntroduction
产品方案
SL
ProductSolution
流程图
WF
WorkFlow
组织结构
RS
OrganizationalStructureChart
实体关系
ER
EntityRelationChart
功能定义
FD
FunctionDefine
产品需求定义
PD
ProductRequirementDefine
数据字典
DataDictionary
架构模型
AM
ArchitectureModel
CRUD矩阵
CM
CRUDMatrix
需求与变更
11
RC
RequirementandChange
确认报告
13
VR
ValidationReport
用户界面
14
UF
UserInterface
测试用例
17
TC
TestingCase
测试报告
18
TR
TestingReport
检查单
19
CL
CheckList
评估报告
20
AR
AssessmentReport
培训
21
Training
缺陷
22
DF
Defect
评审
23
RW
Review
需求跟踪矩阵
24
RT
RequmentTracingMatrix
词语表
25
TerminologyTable
文档序号
文档序号编号应满足如下要求：
文档序号编号由2为数字组成。
不足2两位，左侧用“0”补足。
当相同的子系统、组件或模块，且相同文档种类存在多个文档时，使用文档序号进行编号区分。
当只有一份文档时，文档序号可省略。
语种编号
语种编号应满足如下要求：
语种编号为2位英文大写字母或数字组成。
大写的英文字母是语言的英文名称缩写。
当语言种类为“中文”时，可省略。
常用语种编号示例，参见表6语种编号表。
语种编号表
文档语言名称
文档语种编号
中文
CN
China
EN
English
日文
JP
Japanese
德语
GN
German
软件工程文档编号储备与标注
软件工程文档格式
软件工程文档格式为办公软件的兼容格式，文档用于公布能够采纳PDF格式。
软件工程文档编号储备
在OFFICE的兼容格式文件中，软件工程文档编号存放在文件的“属性”的自定义项目的“文档编号”字段中。
当一个文件中存在多个文档时，存放软件开发主文档编号。
软件工程文档编号标注
在每个文档的封面应标注文档编号。
在电子表格类（如：
XLS）文档中，在表头部分标注文档编号。
在文字类（如：
DOC）文档中，在页眉或页脚中标注文档编号。
（资料性附录）
软件工程文档编号示例
示例讲明
以A软件产品的01子系统为例，讲明软件各类文档编号。
所有文档使用中文编写。
示例中的各种文档在软件开发中只是典型的文档，并不代表软件开发中全部种类文档。
共同文档
01子系统共同文档编号示例如下：
文档名称
文档编号（英文缩写）
文档种类
01子系统数据字典
SSA-01-DD
01子系统的需求跟踪矩阵表
SSA-01-TT
01子系统的词语表
SSA-01-RT
需求跟踪矩阵表
01子系统的缺陷记录（第1个）
SSA-01-DF01
缺陷记录
业务分析过程
01子系统的业务分析文档编号示例如下：
文档编号
01子系统业务介绍
SSA-BA01-PT
介绍
01子系统业务方案
SSA-BA01-SL
方案
01子系统业务流程图
SSA-BA01-WF
01子系统业务有关的组织结构图
SSA-BA01-RS
组织结构图
01子系统数据概念模型
SSA-BA01-ER
实体关系图
01子系统业务功能总体讲明
SSA-BA0100-FD
01子系统业务功能组件01讲明
SSA-BA0101-FD
01子系统业务总体架构图
SSA-BA01-AM
架构图
01子系统业务功能与数据实体CRUD矩阵表
SSA-BA01-CM
01子系统业务分析确认单（第1个）
SSA-BA01-VR01
01子系统业务分析文档评审检查单（第1个）
SSA-BA01-CL01
01子系统业务分析评估报告（第1个）
SSA-BA01-AR01
01子系统业务分析评审记录表（第1个）
SSA-BA01-RW01
评审记录
01子系统业务的培训资料（第1个）
SSA-BA01-TR01
需求定义过程
01子系统的功能需求定义文档编号示例如下：
01子系统的系统功能介绍文档
SSA-RD01-PT
01子系统功能流程图
SSA-RD01-WF
01子系统有关角色组织结构图
SSA-RD01-RS
01子系统的数据逻辑模型
SSA-RD01-ER
01子系统功能需求总体讲明
SSA-RD0100-FD
01子系统功能需求组件01讲明
SSA-RD0101-FD
01子系统总体结构图
SSA-RD01-AM
01子系统CRUD矩阵表
SSA-RD01-CM
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子系统的设计文档编号示例如下：
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
01子系统设计确认票（第1个）
SSA-BD01-VR01
01子系统集成测试用例（第1个）
SSA-TT01-TC01
01子系统设计评审检查单
SSA-BD01-CL
01子系统设计评估报告
SSA-BD01-AR
01子系统设计评审记录表（第1个）
SSA-BD01-RW01
系统测试过程
A子系统的系统测试文档编号示例如下：
01子系统的系统测试介绍文档
SSA-ST01-PT
01子系统的系统测试方案文档
SSA-ST01-SL
01子系统的系统测试用例总体讲明文档
SSA-ST0100-FD
01子系统的01组件系统测试用例讲明文档
SSA-ST0101-FD
01子系统的系统测试评审检查单（第1个）
SSA-ST01-CL01
01子系统的系统测试评估报告
SSA-ST01-AR
系统测试评估报告
01子系统的系统测试评审记录表（第1个）
SSA-ST01-RW01
参 考 文 献
[1]GB/T8566-2007信息技术软件生存周期过程
[2]GB/T8567-2006运算机软件工程文档编制规范
[3]GB/T16680-1996软件工程文档治理指南
[4]GB/T20158-2006信息技术软件生存周期过程配置治理
[5]GB/T19000-2008质量治理体系基础和术语
[6]GB/T7027-2002信息分类和编号的差不多原则与方法
[6]GB/T10113分类编号通用术语
[7]GB/T17710数据处理校验码系统
_________________________________
升级会员 