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

ICS35.080L70DB21辽宁省地方标准DB XX/ XXXXXXXXX计算机软件工程文档编号规范Specification of computer software engineering documentation numbering2013 - XX - XX发布2013 - XX - XX实施发布DBXX/ XXXXXXXXX目次前言II引言III1范围12规范性引用文件13术语和定义13.1文档13.2软件工程文档14文档编号基本规则14.1文档编号字符14.2文档编号基本原则14.3文档编号一般要求24.4分类编号24.5隶属编号25软件工程文档编号25.1软件工程文档编号组成结构35.2软件产品编号35.3软件工程过程编号45.4子系统、组件、模块文档编号45.5文档种类编号65.6文档序号75.7语种编号76软件工程文档编号存储与标注86.1软件工程文档格式86.2软件工程文档编号存储86.3软件工程文档编号标注8附录A（资料性附录）软件工程文档编号示例9参考文献12前言本标准依据GB/T1.12009标准化工作导则 第1部分：标准的结构与编写制定。本标准由大连市经济和信息化委员会提出。本标准由辽宁省经济和信息化委员会归口。本标准起草单位：大连华信计算机技术股份有限公司、大连软件行业协会。本标准主要起草人：刘宏、张静、尹宏、郎庆斌、孙鹏。本标准于2013年xx月xx日首次发布。引言本规范借鉴其他行业的设计文档编号规范，对计算机软件开发过程输出的软件工程文档的编号提出一般性要求。软件工程文档从使用的角度上大致可分为开发方在开发过程中使用的软件工程文档和软件用户需要的用户文档两类。本标准适用于对在开发过程中使用的软件工程文档的编号管理。使用者可根据实际情况对本标准进行适当的裁剪。供方应提供给需方的用户文档类型和编号，由软件的需方和供方在合同中规定。IIIDBXX/ XXXXXXXXX计算机软件工程文档编号规范1 范围本规范规定了文档编号的通用要求，以及软件工程文档编号、软件工程文档编号的存储与标注要求。2 规范性引用文件下列文件中的条款通过本标准的引用而成为本部分的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本部分，然而，鼓励使用本标准的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本部分。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在计算机软件开发过程中所形成、用以描述或规定软件产品必要信息的有关技术文档。4 文档编号基本规则4.1 文档编号字符文档编号一般可采用下列字符表示： 09 阿拉伯数字； AZ 拉丁字母（O、I 除外）； 短横线（-）、圆点（）。4.2 文档编号基本原则a) 科学性：选择事物或概念的最稳定的本质属性或特征作为信息分类的基础和依据。b) 系统性：将选定的事物、概念的属性或特征按一定排列顺序予以系统化，并形成一个合理的科学分类体系。c) 唯一性：一个编号只能唯一地标识一个分类对象。d) 可延性：应设置收容类目，以便保证增加新的事物和概念时，不致打乱已建立的分类体系，同时，还应为下级信息管理系统在原有基础上的延拓、细化创造条件。e) 规范性：同一层级代码的编写格式必须统一。4.3 文档编号一般要求a) 每个产品、子系统、组件、模块的文档均应有独立的编号。1) 采用表格时，表中每个产品、子系统、组件、模块都应标出独立的编号。2) 同一产品、子系统、组件、模块的文档用数张纸印刷成纸介质文档时，各张纸介质文档应标注同一编号。3) 同一文档使用两种以上的存储介质时，每种存储介质中的文档都应标注同一编号。4) 复用文档的编号应采用被复用文档的编号。b) 文档的编号一般可采用分类编号或隶属编号。也可采用将分类编号与隶属编号混合组合方式进行编号。c) 文档的编号应与企业计算机辅助管理分类编号要求相协调。4.4 分类编号分类编号是按对象(软件产品、子系统、组件、模块)、功能、特性等的相似性，采用十进位分类法编号。a) 编号的基本部分由分类号（大类）、特征号（中类）和识别号（小类）三部分组成，中间可以圆点或短横线分开，圆点在下方，短横线在中间。必要时可以在尾部加尾注号。b) 大、中、小类的编号按十进位分类编号法。每类的码位一般由2位数（如软件产品、子系统、组件、模块）组成。表1 分类编号码位的序列及其含义表分类号（大类）特征号（中类）识别号（小类）尾注号校验号软件工程文档按软件开发过程、类型等编号软件产品、子系统、组件、模块区分码位软件工程文档按种类、编写语言等编号软件工程文档、软件产品改进尾注号检验软件产品代号的码位c) 尾注号表示软件工程文档、软件产品改进。一般改进的尾注号用拉丁字母表示。d) 用计算机自动生成软件产品文档编号时，应在编号终端加校验号（校验码）。4.5 隶属编号隶属编号是按系统、组件、模块的隶属关系编号。a) 编号由软件产品编号和隶属号组成。中间可用圆点或短横线隔开，必要时可加尾注号。b) 需要时在首位前加分类号表示计算机辅助管理信息分类编号系统的大类号。c) 系统编号由字母和数字组成。d) 隶属号由数字组成，其级数和位数应按软件产品结构的复杂程度而定。e) 组件的序号，应在其所属（系统或上一级组件）的范围内编号。f) 模块的序号，应在其所属（系统或组件）的范围内编号。g) 编流水号时，可在尾部以带“0”或不带“0”区别模块与组件。5 软件工程文档编号5.1 软件工程文档编号组成结构软件工程文档编号应由8部分组成。各部分位数如下：a) 软件产品编号（3位）b) 工程过程编号（2位）c) 子系统编号（2位）d) 组件编号（2位）e) 模块编号（2位）f) 文档种类编号（2位）g) 文档序号（2位）h) 语种编号（2位）软件工程文档编号采用分类编号与隶属编号混合组合方式。其中工程过程编号、文档种类编号、语种编号应采用分类编号；软件产品编号、子系统编号、组件编号、模块编号是采用隶属编号。软件工程文档编号组成结构参见图 1。软件产品编号（3位）工程过程编号（2位）子系统编号（2位）组件编号（2位）模块编号（2位）文档种类编号（2位）语言种类编号（2位）文档序号（2位）图1 软件工程文档编号组成图5.2 软件产品编号软件产品编号应满足如下要求：a) 软件产品编号应由3位英文大写字母或3为数字组成。b) 当软件产品编号为英文缩写时，表示该软件为软件产品或软件包。3位大写字母应该为软件产品英文缩写。软件产品编号示例，参见表 2 软件产品编号表。表2 软件产品编号表软件产品名称软件产品编号英文数字编号英文缩写编号A系统001SSASystemB系统002SSBSystemC系统003SSCSystemc) 当软件产品编号为数字时，表示在软件产品基础上为客户定制的系统。3为数字应客户代码，不足3位，用“0”从右侧补足3位。为客户定制系统编号示例，参见表3。表3 客户定制系统编号表客户名称软件产品编号演示系统000A客户100B客户200B客户的B1子公司2105.3 软件工程过程编号软件工程过程编号应满足如下要求：a) 软件工程过程编号应由2位大写的英文字母或数字组成。大写的英文字母是软件工程过程的英文名称缩写。软件工程过程的编号示例，参见表4。表4 软件工程过程编号表软件工程过程名称软件工程过程编号英文名称数字编号英文缩写编号业务分析01BABusiness Analysis需求开发02RDRequirement Development概要设计03BDBasic Design详细设计04DDDetail Design编码05CDCoding单体测试06UTUnit Testing集成测试07TTIntegration Testing系统测试08STSystem Testing实施交付09ADApplication Delivery运行维护10PMOperations & Maintenanceb) 软件工程文档在多个软件开发过程中共同进行修改与更新时，软件开发过程文档编号可省略。c) 在软件开发中，不区分软件开发过程时，软件开发过程文档编号可省略。5.4 子系统、组件、模块文档编号子系统、组件、模块文档编号应满足如下要求：a) 子系统、组件、模块文档编号应由软件产品编号加各层顺序号组成。b) 分文档最多不超过5层。c) 每层文档的编号方法应统一，编号应连续。d) 第5层的模块文档采用并列顺序编号，必要时也可以从第4层、第3层或第2层开始采用并列顺序号方法。e) 当本层级顺序号为00时，表示此文档是本层级的公共子系统、组件、模块的软件工程文档。f) 当下一层级顺序为00时，表示存在下一层级分文档。当无下一层级编号时，表示不存在下一层级分文档。子系统、组件、模块文档编号示例，参见图 2。SSA-0100子系统1SSA-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-03010100组件SSA-03010101模块SSA-03010102模块第0层第1层第2层第3层第4层SSA-0000公共子系统SSA-000200公共组件SSA-000201公共模块SSA-000202公共模块图2 子系统、组件、模块文档编号示意图5.5 文档种类编号文档种类编号应满足如下要求：a) 文档种类编号由2位大写的英文字母或数字组成。大写的英文字母是文档种类的英文名称缩写。文档种类编号示例，参见表5。b) 当文档种类名称为“功能定义”时，文档种类编号可省略。表5 文档种类编号表文档种类名称文档种类编号英文数字编号英文缩写编号产品介绍01PTProduct Introduction产品方案02SLProduct Solution流程图03WFWork Flow组织结构04RSOrganizational Structure Chart实体关系05EREntity Relation Chart功能定义06FDFunction Define产品需求定义07PDProduct Requirement Define数据字典08DDData Dictionary架构模型09AMArchitecture ModelCRUD矩阵10CMCRUD Matrix需求与变更11RCRequirement and Change确认报告13VRValidation Report用户界面14UFUser Interface测试用例17TCTesting Case测试报告18TRTesting Report检查单19CLCheck List评估报告20ARAssessment Report培训21TRTraining缺陷22DFDefect评审23RWReview需求跟踪矩阵24RTRequment Tracing Matrix词语表25TTTerminology Table产品介绍01PTProduct Introduction产品方案02SLProduct Solution5.6 文档序号文档序号编号应满足如下要求：a) 文档序号编号由2为数字组成。不足2两位，左侧用“0”补足。b) 当相同的子系统、组件或模块，且相同文档种类存在多个文档时，使用文档序号进行编号区分。c) 当只有一份文档时，文档序号可省略。5.7 语种编号a) 语种编号应满足如下要求：b) 语种编号为2位英文大写字母或数字组成。c) 大写的英文字母是语言的英文名称缩写。d) 当语言种类为“中文”时，可省略。常用语种编号示例，参见表 6 语种编号表。表6 语种编号表文档语言名称文档语种编号英文数字编号英文缩写编号中文01CNChina英文02ENEnglish日文03JPJapanese德语04GNGerman6 软件工程文档编号存储与标注6.1 软件工程文档格式软件工程文档格式为办公软件的兼容格式，文档用于发布可以采用PDF格式。6.2 软件工程文档编号存储在OFFICE的兼容格式文件中，软件工程文档编号存放在文件的“属性”的自定义项目的“文档编号”字段中。当一个文件中存在多个文档时，存放软件开发主文档编号。6.3 软件工程文档编号标注在每个文档的封面应标注文档编号。在电子表格类（如：XLS）文档中，在表头部分标注文档编号。在文字类（如：DOC）文档中，在页眉或页脚中标注文档编号。AA附录A （资料性附录）软件工程文档编号示例A.1 示例说明以A软件产品的01子系统为例，说明软件各类文档编号。所有文档使用中文编写。示例中的各种文档在软件开发中只是典型的文档，并不代表软件开发中全部种类文档。A.2 共同文档01子系统共同文档编号示例如下：文档名称文档编号（英文缩写）文档种类01子系统数据字典SSA-01-DD数据字典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子系统业务功能总体说明SSA-BA0100-FD功能定义01子系统业务功能组件01说明SSA-BA0101-FD功能定义01子系统业务总体架构图SSA-BA01-AM架构图01子系统业务功能与数据实体CRUD矩阵表SSA-BA01-CMCRUD矩阵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培训A.4 需求定义过程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-CMCRUD矩阵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子系统的设计文档编号示例如下：文档名称文档编号文档种类01子系统处理模块流程图SSA-BD01-WF流程图01子系统的数据物理模型SSA-BD01-ER实体关系图01子系统设计总体说明SSA-BD0100-