1CS35.080 L77 GB 中华人民共和国国家标准 GB/T8567一2006 代替GB/T8567-1988 计算机软件文档编制规范 Specification for computer software documentation 2006-03-14发布 2006-07-01实施 中华人民共和国国家质量监督检验检疫总局 发布 爱 中国国家标准化管理委员会
6 中华人民共和国 国家标准 计算机软件文档编制规范 GB/T8567一2006 中国标准出版社出版发行 北京复兴门外三里河北街16号 邮政编码：100045 网址www.bzcbs.com 电话：6852394668517548 中国标准出版社秦皇岛印刷厂印刷 各地新华书店经销 开本880×12301/16印张8字数256千字 2006年9月第一版2006年9月第一次印刷 如有印装差错由本社发行中心调换 版权专有侵权必究 举报电话：(010)68533533
GB/T8567-2006 目 次 前言…… 食 1范围… 1 2规范性引用文件 1 3术语和定义… 1 4缩略语………… 5文档过程… 5.1概述…………4*…………… 5.2源材料准备 ……7 5.3文挡计划…4……………… ………8 5.4文档开发…… 5.5评审… 040…9 5.6与其他公司的文档开发子合同… …10 6文档编制要求……+……… 04044400。 10 6.1软件生存周期与各种文档的编制…… 10 6.2文档编制中的考虑因素· 12 7文档编制格式… 14 7.1可行性分析（研究）报告(FAR) …*………14 7.2软件开发计划(SDP)… 16 7.3软件测试计划(STP)… 23 7.4软件安装计划(SIP)… 27 7.5软件移交计划(STrP)… 30 7.6运行概念说明(OCD) 33 7.7系统/子系统需求规格说明(SSS)… …444+44436 7,8接口需求规格说明(IRS)… 42 7.9系统/子系统设计（结构设计）说明(SSDD)… 46 7.10接口设计说明(IDD)…… 51 7.11软件需求规格说明(SRS)… 54 7.12数据寤求说明(DRD)… 61 7.13软件（结构）设计说明(SDD)… …463 7.14数据库（顶层）设计说明(DBDD) 68 7.15软件测试说明(STD)… 72 7.16软件测试报告(STR)… 76 7.17软件配置管理计划(SCMP)… 78 7.18软件质量保证计划(SQAP) 89 7.19开发进度月报(DPMR) 99 : 7.20项目开发总结报告(PDSR)… …101 7.21软件产品规格说明(SPS) 4…4**…106 7.22软件版本说明(SVD)………… …108
GB/T8567-2006 7.23软件用户手册(SUM)…… 110 7.24计算机操作手册(COM) 113 7.25计算机编程手册(CPM) 115 附录A(规范性附录)面向对象软件的文档编制 …………118 A1综述…118 A.2总体说明文档… …118 A3用况图文挡…1们8 A4类图文档… 119 A.5顺序图文档……… 121 A.6协作图文档 121 A.7状态图文档… ……122 A.8活动图文档… ……123 A9。构件图文档… 124 A.10部署图文档 …124 A.11包图文档 125 参考文献… 126
GB/T8567一2006 前 言 本标准是GB/T8567一1988《计算机软件产品开发文件编制指南》的修订版，并改名为《计算机软 件文档编制规范》。本标准从实施之日起代替GB/T8567一1988。 本标准与GB/T8567一1988相比，主要变化如下： a)本标准增加了文档编写过程。其内容参考了ISO/IEC JTC1/SC7N21061999/04/15《软件工 程—用户文档过程》。 b)本标准主要从软件开发与管理的角度，规定相应的文档及规范。其内容依据GB/T8566一 2001《软件生存周期过程》。 c) 在编写本标雅时，综合了在软件开发与管理中的经验及中软网络技术股份有限公司有关 CMM中拟订的一些文档规范。 d) 本标准与SJ20778一2000《软件开发与文档编制》很好地链接。 )本标准在规定软件需求规格说明、软件测试文件、软件质量保证计划与软件配置管理计划等文 档时，既依据相应的国标，又根据发展与实践经验作了相应的扩展。 f)本标推把SJ/T11291一2003《面向对象的软件系统建模规范第3部分：文档编制》中的文档 e 编制规范作为本标准的规范性附录。 本标准的附录A是规范性附录。 本标准由中华人民共和国信息产业部提出。 本标准由信息产业部电子工业标准化研究所归口。 本标准起草单位：中软网络技术股份有限公司、信息产业部电子工业标准化研究所、北京联想软件 有限公司、用友软件股份有限公司。 本标准主要起草人：周明德、冯惠、韩乃平、欧阳春生、殷树勋、黄万镒、張学锋、韩振江、邓适宜
GB/T8567-2006 计算机软件文档编制规范 1范围 本标准根据GB/T8566一2001《信息技术软件生存周期过程》的规定，主要对软件的开发过程和 管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。 本标准原则上适用于所有类型的软件产品的开发过程和管理过程。 使用者可根据实际情况对本标准进行适当剪裁（可剪裁所需的文档类型，也可对规范的内容作适当 裁剪)。软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的 内部文档（开发文档）两类。供方应提供的文档的类型和规模，由软件的需方和供方在合同中规定。 2规范性引用文件 下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有 的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究 是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。 GB/T8566-2001信息技术软件生存周期过程(idt IS0/IEC12207:1995) GB/T11457-2006软件工程术语 3术语和定义 GB/T11457一2006确立的以及下列术语和定义适用于本标准。 3.1 验收acceptance 需方授权代表的一项活动，通过该活动，需方接受殿行合同的部分或全部的软件产品的所有权。 3.2 需方acquirer 为自已或为另一个组织采购软件产品的组织。 3.3 批准approval 需方的授权代表或开发方的上级组织对开发方的项目计划、设计或其他方面表示满意并可以作为 下一阶段工作基础而签署的书面文件。 3.4 体系结构architecture 一个系统或CSCI(Computer Software Configuration Item一计算机软件配置项)的组织结构，标 明它的组成，这些组成的接口和它们之间的操作概念。 3.5 相关开发方associate developer 一个既不是主承包方也不是开发方的分承包方的组织，但它在同一个或相关的系统或项目中承担 开发工作。 3.6 行为设计behavioral design 从用户观点出发，对整个系统或CSCI的行为进行的设计，它只考虑满足用户需求而不考虑系统或 1
GB/T8567-2006 CSCI的内部实现。这种设计与体系结构设计不同，后者要标明系统或CSCI的内部部件，并有这些部 件的详细设计。 3.7 构建版；开发阶段build (1)软件的一个版本，它满足完整的软件所要满足的全部需求的一个特定的子集。 (2)开发满足特定需求子集的软件版本所经历的时间。 注：术语”开发阶段”和”版本”之间的关系依赖于开发方：例如，可以通过几个版本来实现一个开发阶段，一个开发 阶段也可以发行几个并行的版本（如发往不同的地点），或者将它们用作为同义词。 3.8 计算机数据库computer database 见3.14数据库。 3.9 计算机硬件computer hardware 能接收和存储计算机数据的，对计算机数据执行-一系列系统性的操作的，或能产生控制输出的设 备。这类设备能实现基本的解释、计算、通信、控制或其他逻辑功能。 3.10 计算机程序computer program 能使计算机硬件实现计算或控制功能的计算机指令和数据定义的集合。 3.11 计算机软件computer software 见3.32软件。 3.12 计算机软件配置项computer software configuration item(CSCI) 满足最终使用功能的软件集合，而且它由需方指定进行单独的配置管理。CSCI应从下列诸因素中 进行折衷选择：软件功能、规模、宿主机或目标计算机、开发方、支持概念、重用计划、关键性、接口考虑、 是否需要单独编写文档和控制以及其他因素。 3.13 配置项configuration item 能满足最终使用功能的硬件集合、软件集合或者软、硬件两者的集合，且由需方指定进行单独的配 置管理。 3.14 数据库database 以一种能被用户或计算机程序通过一个数据库管理系统进行访问的方式，存储在一个或多个计算 机文件中的相关数据的集合。 3.15 数据库管理系统database management system 是一整套计算机程序，它提供为建立、修改、使用和完整性维护一个数据库所需的功能。 3.16 可交付的软件产品deliverable software product 合同要求交付给需方或其他指定的接受方的软件产品。 3.17 设计design 开发方为响应一定的需求而对一个系统或CSCI选取的一些性能/规格。这些特性中有些是与需
GB/T8567-2006 求相匹配的：有一些是需求的精细化，如为了响应显示错误信息这一需求而定义所有的错误信息，有一 些则是与实现有关的，如为满足需求，决定选用哪些软件配置项和逻辑。 3.18 开发方developer 开发软件产品的组织(“开发”包括新的软件开发、修改、重用、再工程、维护或产生软件产品的任何 其他活动)。开发方可以是一个承制方或者政府机构。 3.19 文档/文档编制document/documentation 能供人或机器阅读的，一般具有永久性的一套资料（不管它们记录在什么媒体上）。 3.20 评价evaluation 确定一个项或一个活动是否满足指定准则的过程。 3.21 固件firmware 硬件设备和以只读软件的形式驻留在硬件设备上的计算机指令和/或计算机数据的组合。 3.22 硬件配置项hardware configuration item(HWCI) 满足最终使用功能并由需方指定进行单独配置管理的一套硬件。 3.23 独立验证与确认independent verification and validation(IV&V) 由一个机构对软件产品和活动作系统的评估，这个机构不负责该产品的开发或被评估的话动。 IV&V不在本标准的范围内。 3.24 接口interface 在软件开发中，两个或多个实体（如CSCI-CSCI CSCI-HWCI CSCI-用户，或软件配置项-软件配置 项)之间的关系。这些实体依据这种关系共享、提供或交换数据。接口并不是CSCI、软件配置项或其他 的系统部件：接口只是这些实体间的一种关系。 3.25 联合评审joint review 由需方和开发方双方的代表参加的对项目状态、软件产品和/或项目中的问题进行检查和讨论的活 动或会议。 3.26 非交付的软件产品Non-deliverable software product 不是合同中要求交付给需方或其他指定接受方的软件产品。 3.27 过程process 为实现某个既定目的而进行的一组有组织的活动，例如，软件开发过程。 3.28 合格性测试qualification testing 为了向需方表明一个CSCI或系统满足其指定的需求而进行的测试。 3.29 再工程reengineering 为了以一种新的形式重组一个现有的系统而对其进行检查和改造的过程。再工程可包括逆向工程 3
GB/T8567-2006 (分析一个系统并产生更高一级的抽象来表示它，如从代码到设计)、重构（在同一个抽象级上把系统从 一种表示形式转换到另一种表示形式)、重编文档（分析一个系统并产生用户文档式支持文档）、正向工 程（从现有的系统的软件产品结合新的需求，产生新系统）、重定目标系统（对系统进行转换以便将其安 装到不同的目标系统上)和翻译（将源码从一种语言转换到另一种语言或者从一种语言的某个版本转换 成另一种版本)。 3.30 需求requirement (I)为了使需方能够接受一个系统或CSCI所必需具备的特性。 (2)本标准或合同中规定的必须遵守的陈述。 3.31 可重用的软件产品reusable software product 为一个用途开发但还具有别的用途的软件产品，或者专门为了用于多个项目而开发的软件产品，或 者在一个项目中有多种作用的软件产品。例子包括（但不限于）上市的商用软件产品，需方已装备的软 件产品，重用库中的软件产品和开发方现存的软件产品。每一次使用可以包括这些软件产品的全部或 部分，也可以涉及对它的修改。这个术语可以应用于任何软件产品（例如需求，体系结构等）而不只限于 软件本身。 3.32 软件software 计算机程序和计算机数据库。 注：虽然有些软件的定义中包括文档，本标准把这个定义只限于计算机程序和计算机数据库。 3.33 软件开发software development 产生软件产品的一整套活动。软件开发可以包括新开发、修改、重用、再工程、维护或者任何会产生 软件产品的其他活动。 3.34 软件开发文件software development file(SDF) 与特定软件实体开发有关的资料库。其内容一般包括（直接的或引用的）有关需求分忻、设计和实 现的考虑、原理和约束条件；开发方内部的测试资料；进度和状态资料。 3.35 软件开发库software development library(SDL) 一组受控的软件、文档、其他中间的和最终的软件产品，以及相关的用以促进软件的有序开发和后 续支持的工具和方法。 3.36 软件开发过程software development process 为了把用户的需求转换成软件产品而进行的一系列有组织的活动。 3.37 软件工程software engineering 一般情况下，它是软件开发的同义词。在本标准中，软件工程是软件开发的一个子集，它包含除了 合格性测试之外的全部活动。本标准之所以加以这种区分只是为了给软件工程和软件测试环境以不同 的命名。 3.38 软件工程环境software engineering environment 实施软件工程所需要的设施、硬件、软件、固件、方法和文档。它可以包括（但不限于）计算机辅助软
GB/T8567-2006 件工程(CASE)的工具、编译程序、汇编程序、连接程序、装载程序、操作系统、排错程序、仿真程序、模拟 程序、文档工具和数据库管理系统。 3.39 软件产品software product 为了满足一个合同而建立、修改或组合的软件及相关资料。例如包括计划、需求、设计、代码、数据 库、测试资料和手册。 3.40 软件质量software quality 软件满足所规定的需求的能力。 3.41 软件支持software support 为保证软件安装后能继续按既定目标持续运行而且在系统的运行中能起到既定的作用而实施的一 系列活动。软件支持包括软件维护、用户支持和有关的活动。 3.42 软件系统software system 只由软件组成的系统，有时可能还包括该软件赖以运行的计算机设备。 3.43 软件测试环境software test environment 为完成软件合格性测试和可能的其他测试所需的设施、硬件、软件、固件、方法和文档。其要素可以 包括（但不限于）仿真程序、代码分析程序、测试用例生成程序和路径分析程序，还可能包括在软件工程 环境下用到的要素。 3.44 软件移交software transition 使软件开发的责任从一个组织转交给另一个组织的一系列话动。一般说，前一个组织是实现初期 软件开发，而后一个组织是进行软件支持。 3.45 软件单元software unit CSCI设计中的一个基本单位：例如，CSCI的一个主要分支，该分支的一个组成部分、一个类、对象、 模块、函数、子程序或者数据库。软件配置项可以出现在层次结构的不同层上并可以由其他的软件配置 项组成。设计中的软件配置项与实现它们的代码和数据实体（例程、过程、数据库、数据文件等）及或包 含这些实体的计算机文件之间不一定有一一对应的关系。 4缩略语 CASE 计算机辅助软件工程(Computer Assistant Software Engineering) COM 计算机操作手册(Computer Operation Manual) CPM 计算机编程手册(Computer Programming Manual) CSCI 计算机软件配置项(Computer Software Configuration Item) DBDD 数据库（顶层）设计说明(Database Design Description) DID 资料条目说明(Data Item Description) DPMR 开发进度月报(Development Plan Month Report) DRD 数据需求说明(Data requirement Description) FAR 可行性分析报告(Feasibility analysis Report). HWCI 硬件配置项(Hardware Configuration Item) 5
