ICS35.080 L77 G弓 中华人民共和国国家标准 GBT85672006 代替GBT8567-1988 计算机软件文档编制规范 Specification for computer software documentation 200603-14发布 20060701实施 中华人民共和国国家质量监督检验检疫总局发布 中国国家标准化管理委员会
ICS 35.080 L 77 中华人民共和国国家标准 GB/T 8567-2006 代替GB/T 8567-1988 计算机软件文档编制规范 Specification for computer software documentation 2006-03-14发布 2006-07-01实施 中华人民共和国国家质量监督检验检疫总局 中 国 国 家 标 准 化 管 理 委 员 会 发布
目次 前言 7.12数据需求说明ORD 范围 7.13软件(结构)设计说明(SDD 规范性引用文件 7.14数据库(顶层)设计说明OBD) 3术语和定义 7.15软件测试说明(STD) 缩略语 7.16软件测试报告(STR) 5文档过程 7.17软件配置管理计划(SCMP) 5.1概述 7.18软件质量保证计划(SQAP) 5.2源材料准备 7.19开发进度月报(DPMR 5.3文档计划 7.20项目开发总结报告(PDSR) 5.4文档开发 7.21软件产品规格说明(SPS 5.5评审 7.22软件版本说明(SVD) 5.6与其他公司的文档开发子合同 7.23软件用户手册(SUM 6文档编制要求 7.24计算机操作手册(COM) 6.1软件生存周期与各种文档的编制 7.25计算机编程手册(CPM 6.2文档编制中的考虑因素 附录A(规范性附录)面向对象软件的文档编制 7文档编制格式 A.1综述 7.1可行性分析(研究)报告(FAR) A.2总体说明文档 7.2软件开发计划(SDP) A.3用况图文档 7.3软件测试计划(STP) A.4类图文档 7.4软件安装计划(SIP) A.5顺序图文档 7.5软件移交计划(STrP) A.6协作图文档 7.6运行概念说明(OCD) A.7状态图文档 7.7系统/子系统需求规格说明(SSS) A.8活动图文档 7.8接口需求规格说明(IRS) A.9构件图文档 7.9系统/子系统设计(结构设计)说明(SSDD) A.10部署图文档 7.10接口设计说明(IDD) A.11包图文档 7.11软件需求规格说明(SRS 参考文献
目 次 前言 1 范围 2 规范性引用文件 3 术语和定义 4 缩略语 5 文档过程 5．1 概述 5．2 源材料准备 5．3 文档计划 5．4 文档开发 5．5 评审 5．6 与其他公司的文档开发子合同 6 文档编制要求 6．1 软件生存周期与各种文档的编制 6．2 文档编制中的考虑因素 7 文档编制格式 7．1 可行性分析(研究)报告(FAR) 7．2 软件开发计划(SDP) 7．3 软件测试计划(STP) 7．4 软件安装计划(SIP) 7．5 软件移交计划(STrP) 7．6 运行概念说明(OCD) 7．7 系统/子系统需求规格说明(SSS) 7．8 接口需求规格说明(IRS) 7．9 系统/子系统设计(结构设计)说明(SSDD) 7．10 接口设计说明(IDD) 7．11 软件需求规格说明(SRS) 7．12 数据需求说明(DRD) 7．13 软件(结构)设计说明(SDD) 7．14 数据库(顶层)设计说明(DBDD) 7．15 软件测试说明(STD) 7．16 软件测试报告(STR) 7．17 软件配置管理计划(SCMP) 7．18 软件质量保证计划(SQAP) 7．19 开发进度月报(DPMR) 7．20 项目开发总结报告(PDSR) 7．21 软件产品规格说明(SPS) 7．22 软件版本说明(SVD) 7．23 软件用户手册(SUM) 7．24 计算机操作手册(COM) 7．25 计算机编程手册(CPM) 附录 A(规范性附录)面向对象软件的文档编制 A．1 综述 A．2 总体说明文档 A．3 用况图文档 A．4 类图文档 A．5 顺序图文档 A．6 协作图文档 A．7 状态图文档 A．8 活动图文档 A．9 构件图文档 A．10 部署图文档 A．11 包图文档 参考文献
GB/T8567-2006《计算机软件文档编制规范》 前 言 本标准是GB/T8567-1988《计算机软件产品开发文件编制指南》的修订版,并改名为《计算机软件文 档编制规范》。本标准从实施之日起代替GB/T8567-1988。 本标准与GB/T8567-1988相比,主要变化如下: a)本标准增加了文档编写过程。其内容参考了ISO/ IECJTCI/SC7N21061999/04/15《软件工程一一用 户文档过程》。 b)本标准主要从软件开发与管理的角度,规定相应的文档及规范。其内容依据GB/T8566-2001《软 件生存周期过程》 c)在编写本标准时,综合了在软件开发与管理中的经验及中软网络技术股份有限公司有关CMM 中拟订的一些文档规范。 d)本标准与SJ20778-2000《软件开发与文档编制》很好地链接。 e)本标准在规定软件需求规格说明、软件测试文件、软件质量保证计划与软件配置管理计划等文档 时,既依据相应的国标,又根据发展与实践经验作了相应的扩展 f)本标准把SJ/T11291—2003《面向对象的软件系统建模规范第3部分:文档编制》中的文档编制 规范作为本标准的规范性附录。 本标准的附录A是规范性附录。 本标准由中华人民共和国信息产业部提出。 本标准由信息产业部电子工业标准化研究所归口。 本标准起草单位:中软网络技术股份有限公司、信息产业部电子工业标准化研究所、北京联想软件有 限公司、用友软件股份有限公司 本标准主要起草人:周明德、冯惠、韩乃平、欧阳春生、殷树勋、黄万镒、强学锋、韩振江、邓适宜
GB/T 8567-2006《计算机软件文档编制规范》 前 言 本标准是GB/T8567—1988《计算机软件产品开发文件编制指南》的修订版，并改名为《计算机软件文 档编制规范》。本标准从实施之日起代替GB/T8567—1988。 本标准与GB/T8567—1988相比，主要变化如下： a) 本标准增加了文档编写过程。其内容参考了ISO/IECJTCl/SC7N21061999/04/15《软件工程——用 户文档过程》。 b) 本标准主要从软件开发与管理的角度，规定相应的文档及规范。其内容依据GB/T8566—2001《软 件生存周期过程》。 c) 在编写本标准时，综合了在软件开发与管理中的经验及中软网络技术股份有限公司有关CMM 中拟订的一些文档规范。 d) 本标准与SJ20778—2000《软件开发与文档编制》很好地链接。 e) 本标准在规定软件需求规格说明、软件测试文件、软件质量保证计划与软件配置管理计划等文档 时，既依据相应的国标，又根据发展与实践经验作了相应的扩展。 f) 本标准把SJ/T11291—2003《面向对象的软件系统建模规范第3部分：文档编制》中的文档编制 规范作为本标准的规范性附录。 本标准的附录A是规范性附录。 本标准由中华人民共和国信息产业部提出。 本标准由信息产业部电子工业标准化研究所归口。 本标准起草单位：中软网络技术股份有限公司、信息产业部电子工业标准化研究所、北京联想软件有 限公司、用友软件股份有限公司。 本标准主要起草人；周明德、冯惠、韩乃平、欧阳春生、殷树勋、黄万镒、强学锋、韩振江、邓适宜
GB/T8567-2006《计算机软件文档编制规范》 计算机软件文档编制规范 1范围 本标准根据GB/T8566-2001《信息技术软件生存周期过程》的规定,主要对软件的开发过程和管理过程 应编制的主要文档及其编制的内容、格式规定了基本要求 本标准原则上适用于所有类型的软件产品的开发过程和管理过程。 使用者可根据实际情况对本标准进行适当剪裁(可剪裁所需的文档类型,也可对规范的内容作适当裁剪) 软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的内部文档(开发文 档)两类。供方应提供的文档的类型和规模,由软件的需方和供方在合同中规定。 2规范性引用文件 下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件,其随后所有的修改单 (不包括勘误的内容)或修订版均不适用于本标准,然而,鼓励根据本标准达成协议的各方研究是否可使用这些 文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本标准 GB/T8566-2001信息技术软件生存周期过程( idt Iso/IEC:12207:1995) GB/T11457-2006软件工程术语 3术语和定义 B/T11457-2006确立的以及下列术语和定义适用于本标准 3.1验收 acceptance 需方授权代表的一项活动,通过该活动,需方接受履行合同的部分或全部的软件产品的所有权。 3.2需方 acquire 为自己或为另一个组织采购软件产品的组织 33批准 approva1 需方的授权代表或开发方的上级组织对开发方的项目计划、设计或其他方面表示满意并可以作为下一阶段 工作基础而签署的书面文件 3.4体系结构 architecture 个系统或CSCI( Computer Software Configuration Item-计算机软件配置项)的组织结构,标明它的组 成,这些组成的接口和它们之间的操作概念。 3.5相关开发方 associate developer 个既不是主承包方也不是开发方的分承包方的组织,但它在同一个或相关系统或项目中承担开发工作 3.6行为设计 behavioral design 从用户观点出发,对整个系统或CScI的行为进行的设计,它只考虑满足用户需求而不考虑系统或CSCI 的内部实现。这种设计与体系结构设计不同,后者要标明系统或CSCI的内部部件,并有这些部件的详细设计。 3.7构建版;开发阶段 build (1)软件的一个版本,它满足完整的软件所要满足的全部需求的一个特定的子集。 (2)开发满足特定需求子集的软件版本所经历的时间 注:术语开发阶段”和版本”之间的关系依赖于开发方:例如,可以通过几个版本来实现一个开发阶 段,一个开发阶段也可以发行几个并行的版本(如发往不同的地点),或者将它们用作为同义词。 38计算机数据库 computer database 见3.14数据库 3.9计算机硬件 computer hardware 能接收和存储计算机数据的,对计算机数据执行一系列系统性的操作的,或能产生控制输出的设备。这类 设备能实现基本的解释、计算、通信、控制或其他逻辑功能。 3.10计算机程序 computer program
GB/T 8567-2006《计算机软件文档编制规范》 计算机软件文档编制规范 1 范围 本标准根据 GB/T 8566—2001《信息技术软件生存周期过程》的规定，主要对软件的开发过程和管理过程 应编制的主要文档及其编制的内容、格式规定了基本要求。 本标准原则上适用于所有类型的软件产品的开发过程和管理过程。 使用者可根据实际情况对本标准进行适当剪裁(可剪裁所需的文档类型，也可对规范的内容作适当裁剪)。 软件文档从使用的角度大致可分为软件的用户需要的用户文档和开发方在开发过程中使用的内部文档(开发文 档)两类。供方应提供的文档的类型和规模，由软件的需方和供方在合同中规定。 2 规范性引用文件 下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有的修改单 (不包括勘误的内容)或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些 文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。 GB/T 8566—2001 信息技术软件生存周期过程(idt ISO/IEC：12207：1995) GB/T 11457—2006 软件工程术语 3 术语和定义 GB/T 11457—2006 确立的以及下列术语和定义适用于本标准。 3.1 验收 acceptance 需方授权代表的一项活动，通过该活动，需方接受履行合同的部分或全部的软件产品的所有权。 3.2 需方 acquinr 为自己或为另一个组织采购软件产品的组织。 3.3 批准 approval 需方的授权代表或开发方的上级组织对开发方的项目计划、设计或其他方面表示满意并可以作为下一阶段 工作基础而签署的书面文件。 3.4 体系结构 architecture 一个系统或 CSCI(Computer Software Configuration Item-计算机软件配置项)的组织结构，标明它的组 成，这些组成的接口和它们之间的操作概念。 3.5 相关开发方 associate developer 一个既不是主承包方也不是开发方的分承包方的组织，但它在同一个或相关系统或项目中承担开发工作。 3.6 行为设计 behavioral design 从用户观点出发，对整个系统或 CScI 的行为进行的设计，它只考虑满足用户需求而不考虑系统或 CSCI 的内部实现。这种设计与体系结构设计不同，后者要标明系统或 CSCI 的内部部件，并有这些部件的详细设计。 3.7 构建版；开发阶段 build (1)软件的一个版本，它满足完整的软件所要满足的全部需求的一个特定的子集。 (2)开发满足特定需求子集的软件版本所经历的时间。 注：术语一开发阶段”和一版本”之间的关系依赖于开发方：例如，可以通过几个版本来实现一个开发阶 段，一个开发阶段也可以发行几个并行的版本(如发往不同的地点)，或者将它们用作为同义词。 3.8 计算机数据库 computer database 见 3.14 数据库。 3.9 计算机硬件 computer hardware 能接收和存储计算机数据的，对计算机数据执行一系列系统性的操作的，或能产生控制输出的设备。这类 设备能实现基本的解释、计算、通信、控制或其他逻辑功能。 3.10 计算机程序 computer program
GB/T8567-2006《计算机软件文档编制规范》 能使计算机硬件实现计算或控制功能的计算机指令和数据定义的集合, 3.11计算机软件 computer software 见3.32软件。 3.12计算机软件配置项 computer software configuration item(CSCI) 满足最终使用功能的软件集合,而且它由需方指定进行单独的配置管理。CSCI应从下列诸因素中进行折 衷选择:软件功能、规模、宿主机或目标计算机、开发方、支持概念、重用计划、关键性、接口考虑、是否需 要单独编写文档和控制以及其他因素。 3.13配置项 configuration i tem 能满足最终使用功能的硬件集合、软件集合或者软、硬件两者的集合,且由需方指定进行单独的配置管理。 3.14数据库 database 以一种能被用户或计算机程序通过一个数据库管理系统进行访问的方式,存储在一个或多个计算机文件中 的相关数据的集合 3.15数据库管理系统 database management system 是一整套计算机程序,它提供为建立、修改、使用和完整性维护一个数据库所需的功能。 3.16可交付的软件产品 deliverable software product 合同要求交付给需方或其他指定的接受方的软件产品 3.17设计 design 开发方为响应一定的需求而对一个系统或CSCI选取的一些性能/规格。这些特性中有些是与需GB/T 8567-2006求相匹配的:有一些是需求的精细化,如为了响应显示错误信息这一需求而定义所有的错误信息 有一些则是与实现有关的,如为满足需求,决定选用哪些软件配置项和逻辑。 3.18开发方 developer 开发软件产品的组织(“开发”包括新的软件开发、修改、重用、再工程、维护或产生软件产品的任何其 他活动)。开发方可以是一个承制方或者政府机构 3.19文档/文档编制 document/ documentation 能供人或机器阅读的,一般具有永久性的一套资料(不管它们记录在什么媒体上)。 3.20评价 evaluatic 确定一个项或一个活动是否满足指定准则的过程。 3.21固件 firmware 硬件设备和以只读软件的形式驻留在硬件设备上的计算机指令和/或计算机数据的组合 3.22硬件配置项 hardware configuration item(WCI) 满足最终使用功能并由需方指定进行单独配置管理的一套硬件。 3.23独立验证与确认 independent verification and validation(IV&v) 由一个机构对软件产品和活动作系统的评估,这个机构不负责该产品的开发或被评估的活动。IV&V不在 本标准的范围内 3.24接口 interface 在软件开发中,两个或多个实体(如cscI- CscI cSCI-HwC: I CSCI一用户,或软件配置项一软件配置项) 之间的关系。这些实体依据这种关系共享、提供或交换数据。接口并不是CSCI、软件配置项或其他的系统部 件:接口只是这些实体间的一种关系 3.25联合评审 joint review 由需方和开发方双方代表参加的对项目状态、软件产品和/或项目中的问题进行检查和讨论的活动或会议 326非交付的软件产品Non- deliverable softwaer product 不是合同中要求交付给需方或其他指定接受方的软件产品 3.27过程 process 为实现某个既定目的而进行的一组有组织的活动,例如,软件开发过程 328合格性测试 qualification testing 为了向需方表明一个CCI或系统满足其指定的需求而进行的测试
GB/T 8567-2006《计算机软件文档编制规范》 能使计算机硬件实现计算或控制功能的计算机指令和数据定义的集合。 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/T 8567-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—HWC：I CSCI 一用户，或软件配置项一软件配置项) 之间的关系。这些实体依据这种关系共享、提供或交换数据。接口并不是 CSCI、软件配置项或其他的系统部 件；接口只是这些实体间的一种关系。 3.25 联合评审 joint review 由需方和开发方双方代表参加的对项目状态、软件产品和/或项目中的问题进行检查和讨论的活动或会议。 3.26 非交付的软件产品 Non-deliverable softwaer product 不是合同中要求交付给需方或其他指定接受方的软件产品。 3.27 过程 process 为实现某个既定目的而进行的一组有组织的活动，例如，软件开发过程。 3.28 合格性测试 qualification testing 为了向需方表明一个 CSCI 或系统满足其指定的需求而进行的测试