GB/T 8567-2006《计算机软件文档编制规范》之 软件版本说明(SVD)

说明：

1.《软件版本说明》(SVD)标识并描述了由一个或多个计算机软件配置项(CSCI)组成的一个软件的版本。它被用于发行、追踪以及控制软件的版本。

2.术语”版本”可用于软件的最初发行，用于其后续的发行，或用于在几乎同时发行的软件的多种形式之一(例如，用于不同的场所等)。

 

 

 

 

 

1引言

1.1标识

本条应包含本文档适用的系统和软件的完整标识，(若适用)包括标识号、标题、缩略词语、版本号和发行号。它也应标识SVD预期的接受者和该标识影响发行软件的内容的程度(例如，源代码可能不向所有的接受者发行)。

1.2系统概述

本条应简述本文档适用的系统和软件的用途。它应描述系统和软件的一般特性；概述系统的开发、运行与维护的历史；标识项目的投资方、需方、用户、开发方和支持机构；标识当前和计划的运行现场；并列出其他有关的文档。

1.3文档概述

本条应概述本文档的用途和内容，并描述与其使用有关的保密性或私密性要求。

2引用文件

本章应列出本文档引用的所有文档的编号、标题、修订版本和日期。也应标识不能通过正常的供货渠道获得的所有文档的来源。

3版本说明

本章应分为以下几条。

3.1发行材料清单

(若适用)本条应通过标识号、标题、缩略语、日期、版本号和发行号列出构成发行软件的所有物理媒体(例如列表、磁带、磁盘)和有关的文档。它应包括适用于这些项的保密性和私密性要求、处理它们的安全措施(例如对静电和磁场的关注)和关于复制和许可证条款的说明和制约。

3.2软件内容清单

(若适用)本条应通过标识号、标题、缩略语、日期、版本号和发行号列出构成发行软件版本的所有计算机文件。应包含适用的保密性和私密性要求。

3.3已安装的变更

本条应包含一张列表，记录当前的软件版本自上一个版本后引人的所有变更。如果使用了变更类别，则变更应按这些类别进行划分。(若适用)本条应标识与每一变更和(若有)每一变更对系统运行和其他软硬件接口产生的影响相关的问题报告、变更建议和变更通告。本条不适用于最初的软件版本。

3.4适应性资料

本条应标识或引用包含在软件版本中的所有场地专用的资料。对于第一版之后的软件版本，本条应描述对适应性资料做的变更。

3.5相关文档

(若适用)本条应按标识号、标题、缩略语、日期、版本号和发行号列出与发行软件有关但未包含在其中的所有文档。

3.6安装指令

(若适用)本条应提供或引用以下信息：

a.安装该软件版本的指令；

b.为使该版本可用而必须安装的其他变更的标识，包括未包含在软件版本中的场地专用的适应性资料；

c.与安装有关的保密性、私密性和安全提示；

d.判定版本是否被正确安装的过程；

e.安装中遇到问题后的求助联系地点。

3.7可能的问题和已知的错误

本条应标识软件版本在发行时可能存在的问题或已知的错误、解决问题和错误应采取的步骤、以及说明(直接或通过引用)如何识别、避免、更正或处理问题和错误的处理措施。给出的信息应适合于SVD预期的受众(例如一个用户机构可能需要避免错误的建议，支持机构则需要改正错误的建议)。

4注解

本章应包含有助于理解本文档的一般信息(例如背景信息、词汇表、原理)。本章应包含为理解本文档需要的术语和定义，所有缩略语和它们在文档中的含义的字母序列表。

附录

附录可用来提供那些为便于文档维护而单独出版的信息(例如图表、分类数据)。为便于处理，附录可单独装订成册。附录应按字母顺序(A,B等)编排。