GB/T 8567-2006 "Computer Software Documentation Specification" Software Product Specification (SPS)

illustrate:

1. The Software Product Specification (SPS) contains or references executable software, source files, and software support information. Including a computer software configuration item (CSCI) "as built" design information and editing, construction and modification process.

2. SPS can be used to order executable software and / or source files corresponding to the CSCI . It is the basic software support document for this CSCI . Note that different organizations have different policies for ordering and handing over software. This strategy should be decided before using this document.

 

 

 

 

 

1 Introduction

1.1 Identification

This paragraph shall contain the complete identification of the systems and software to which this document applies, including, if applicable , identification numbers, titles, acronyms, version numbers, release numbers.

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 nature of the system and software; outline the history of system development, operation, and maintenance; identify the project's investors, acquirers, users, developers, and support agencies; identify current and planned operational sites; and list other relevant documentation.

1.3 Documentation overview

This paragraph shall outline the purpose and content of this document and describe the confidentiality and 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 Requirements

本章应分为以下几条,规定必须满足的需求,以实现软件交付和建立另一软件实体,以使其被认为是该CSCI的一个有效拷贝。

注:本章将软件自身作为被认为是CSCI的一个有效拷贝软件实体所必须匹配的准则。被更新的软件设计不作为需求,而被放在第5章,仅作为用于修改、增强或其他支持该软件时所使用的信息。如果此规格说明的任何部分被置于需方配置的控制之下,只应限于第3章。建立产品基线的是软件自身,而不是软件的设计说明.

3.1可执行软件

本条应通过引用所附的或其他形式提供的电子媒体给出CSCI的可执行软件,它应包括在目标计算机上安装和操作该软件所需的批处理文件、命令文件、数据文件或其他软件文件。为使一软件实体被认为是CSCI可执行软件的有效拷贝,它必须精确匹配这些文件。

3.2源文件

本条应通过引用所附的或其他形式提供的电子媒体给出该CSCI的源文件,它应包括重新产生CSCI的可执行软件所需的批处理文件、命令文件、数据文件或其他文件。为使一软件实体被认为是该CSCI源文件的有效拷贝,它必须精确匹配这些文件。

3.3打包需求

(若有)本条应陈述打包和标记CSCI拷贝的需求。

4合格性规定

本条应陈述用于证明给定软件实体是CSCI有效拷贝要使用的方法。例如,针对可执行文件所使用的方法可以这样制定,即3.1条中引用到的每个可执行文件在当前所讨论软件中有相同命名的对等实体,并且可通过按位比较、检查和、或其他方法表明每个这样的对等实体和对应的可执行文件是相同的。针对源文件所使用的方法是与3.2条中引用的源文件进行比较。

5软件支持信息

本章应分为以下几条提供为了支持CSCI所需的信息。

5.1“已建成”软件设计

本条应包含描述“已建成”CSCI设计的信息,或引用包含此信息的一个附录或其他可交付的文档。(若适用)此信息应与软件(结构)设计说明(SDD)、接口设计说明(IDD)和数据库(顶层)设计说明(DBDD)所要求的信息相同。如果这些文档或其等价物要随“已建成”CSCI交付,本条应引用它们。否则,此信息应在本文档中提供。可以引用头文件、注释、源代码清单中的代码提供的信息,此处无需重复。如果SDD, IDDDBDD是以附录的形式提供的话,无需变更其条号与页码。

5.2编译/建立过程

本条应描述从源文件创建可执行文件和准备向固件或其他分布媒体中加载可执行文件所要使用的编译/建立过程,或引用描述此信息的附录。应指定所用的编译程序/汇编程序,包括版本号:其他所需的软、硬件,包括版本号;要使用的设置、选项或约定;和编译/汇编、连接和建立CSCI和包含CSCI的软件系统/子系统的过程,包括对不同现场、配置、版本的变更等。CSCI级之上的建立过程可以在一个SPS中给出,而在其他SPS中引用。

5.3修改过程

本条应描述修改CSCI必须遵循的过程。(若适用)包括或引用下述信息:

a.支持设施、设备和软件,以及它们的使用过程;

b.CSCI所使用的数据库/数据文件,以及使用与修改它们的过程;

c.设计、编码、及其他应遵循的约定;

d.(若有)与上述不同的编译/建立过程;

e.应遵循的集成与测试过程。

5.4计算机硬件资源使用

本条应描述“已建成的"CSCI对计算机硬件资源(如处理器能力、内存容量、输入/输出设备能力、辅存容量和通信/网络设备能力)的量化的使用情况。应覆盖包括在CSCI使用需求中的、影响CSCI的系统级资源分配中的、或软件开发计划中的所有计算机硬件资源。如果一个给定的计算机硬件资源的所有使用数据出现在同一个地方,如在一个SPS中,则本条可以引用它。针对每一计算机硬件资源,应包括:

a.得到满足的CSCI需求或系统级资源分配(CSCI需求的可追踪性可在6.c中提供)

b.使用数据所基于的假设和条件(例如,典型用法、最坏情况用法、特定事件的假设)

c.影响使用的特殊考虑(例如虚存的使用、覆盖、多处理器或操作系统开销的影响、库软件或其他的实现开销等)

d.所采用的计量单位(例如处理器能力百分比、每秒周期、存储器字节数、每秒千字节等)

e.所进行的评估或计量的级别(例如软件配置项、CSCI,或可执行程序)

6需求的可追踪性

本章应包括:

a.从每一CSCI源文件到它所实现的软件配置项的可追踪性;

b.从每一软件配置项到实现它的源文件的可追踪性;

c.5.4中给定的每一计算机硬件资源使用计量到它所涉及的CSCI需求的可追踪性。(此可追踪性也可在5.4中提供)

d.从有关计算机硬件资源使用的每一CSCI需求到5.4中给定的使用计量的可追踪性。

7注解

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

附录

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

Guess you like

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