GB/T 8567-2006 "Computer Software Documentation Specification" Software Version Description (SVD)

illustrate:

1. The Software Release Notes (SVD) identify and describe a software version consisting of one or more Computer Software Configuration Items (CSCI) . It is used to distribute, track, and control software versions.

2. The term "version" may be used for the initial release of software, for subsequent releases thereof, or for one of several forms of software that are released at approximately the same time ( eg, in different venues, etc. ) .

 

 

 

 

 

1 Introduction

1.1 Identification

This paragraph shall contain the complete identification of the systems and software to which this document applies, including , where applicable , identification numbers, titles, acronyms, version numbers, and release numbers. It should also identify the intended recipients of the SVD and the extent to which this identification affects the content of the distributed software ( eg, source code may not be distributed to all recipients ) .

1.2 System overview

This paragraph should briefly describe the purpose of the systems and software to which this document applies. It should describe the general characteristics of the system and software; outline the history of the system's development, operation, and maintenance; identify the project's investors, acquirers, users, developers, and support agencies; identify current and planned operational sites; and list other related documentation.

1.3 Documentation overview

This paragraph shall outline the purpose and content of this document and describe the confidentiality or privacy requirements associated with its use.

2 Reference documents

This chapter should list the numbers, titles, revisions, and dates of all documents referenced in this document. The source of all documentation not available through normal supply channels should also be identified.

3 Release Notes

This chapter should be divided into the following sections.

3.1 List of Issued Materials

( If applicable ) This section shall list, by identification number, title, acronym, date, version number, and release number, all physical media ( eg, listings, tapes, disks ) and related documentation that make up the distributed software. It should include confidentiality and privacy requirements applicable to these items, safeguards for handling them ( such as concerns about static electricity and magnetic fields ) , and instructions and restrictions on reproduction and licensing terms.

3.2 Software Content List

( If applicable ) This section shall list, by identification number, title, acronym, date, version number, and release number, all computer files that constitute the released version of the software. Applicable confidentiality and privacy requirements should be included.

3.3 Installed changes

This clause shall contain a list of all changes introduced by the current software version since the previous version. If change categories are used, the changes shall be grouped by those categories. ( If applicable ) This paragraph shall identify problem reports, change proposals, and change notices associated with each change and , if any , the effect of each change on system operation and other hardware and software interfaces. This section does not apply to the original software version.

3.4 Adaptation data

This paragraph shall identify or reference all site-specific materials included in the software release. For software versions after the first version, this paragraph shall describe the changes made to the adaptation data.

3.5 Related documents

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

3.6安装指令

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

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

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

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

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

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

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

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

4注解

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

附录

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

Guess you like

Origin http://10.200.1.11:23101/article/api/json?id=326655948&siteId=291194637