理论教育 软件文档编制要求及控制、验收规范

软件文档编制要求及控制、验收规范

时间:2023-06-17 理论教育 版权反馈
【摘要】:4)质量控制要求:描述软件关键性等级、标准、文档、配置管理、测试、分承制方等方面的要求。5)验收和交付:描述软件的验收准则,软件的交付形式、数量、装载媒体,交付的文档清单和软件的版权保护等方面的要求。根据实际需要,可将SDP中的某些部分编制成单独的计划。

软件文档编制要求及控制、验收规范

1845.在软件开发过程中可产生下列文档:运行方案说明(OCD)、系统/子系统规格说明(SSS)、接口需求规格说明(IRS)、系统/子系统设计说明(SS-DD)、接口设计说明(IDD)、软件研制任务书(SDTD)、软件开发计划(SDP)、软件配置管理计划(SCMP)、软件质量保证计划(SQAP)、软件安装计划(SIP)、软件移交计划(STrP)、软件测试计划(STP)、软件需求规格说明(SRS)、软件设计说明(SDD)、数据库设计说明(DBDD)、软件测试说明(STD)、软件测试报告(STR)、软件产品规格说明(SPS)、软件版本说明(SVD)、软件用户手册(SUM)、软件输入/输出手册(SIOM)、软件中心操作员手册(SCOM)、计算机编程手册(CPM)、计算机操作手册(COM)、固件保障手册(FSM)、软件研制总结报告(SDSR)、软件配置管理报告(SCMR)、软件质量保证报告(SQAR)。

1846.软件设计可根据项目所选择的生存周期、软件研制任务书的要求及实际活动,确定项目产生文档的种类,并根据实际情况对文档的种类进行合并、拆分。若两个或多个文档合并,以其中一个文档为主文档,将其他文档的内容有机地组合到主文档中,组合后形成的文档的要素应保持完整不遗漏,并在注释中说明。同理,文档拆分为两个或多个文档,拆分前后文档的要素应保持一致,并在其中的一个文档的注释中对拆分情况进行说明。根据需要,也可以对文档内容进行裁减。若裁减了某章或某条,则在被裁去的章条的标题下标识为“本章无内容”或“本条无内容”,并说明理由。

1847.运行方案说明(OCD)描述系统应满足的用户需要、与现有系统或规程的关系以及使用方式等。运行方案说明(OCD)既可向开发者表达用户的需要,也可向用户或其他对象表达开发者的思路,以便在需求方、开发方、保障机构和用户之间,对所开发的系统的运行方案达成共识。

1848.系统/子系统规格说明(SSS)描述系统的需求,以及确保满足各需求所使用的方法。系统外部接口方面的相关需求,可在SSS中给出或在引用的一个或多个《接口需求规格说明》中给出。SSS可由《接口需求规格说明》补充,共同构成系统设计与合格性测试的基础。系统/子系统设计说明(SSDD)描述系统/子系统的系统级或子系统级设计决策与体系结构设计。SSDD与其相关的《接口设计说明》和《数据库设计说明》,共同构成系统实现的基础。

1849.接口需求规格说明(IRS)描述作用于一个或多个系统、子系统、硬件配置项、计算机软件配置项、人工操作或其他系统部件之间的需求,从而实现这些实体间的一个或多个接口。一个IRS可以包含多个接口。

1850.接口设计说明(IDD)描述一个或多个系统或子系统、硬件配置项、计算机软件配置项、人工操作或其他系统部件的接口特性。一个IDD可以描述多个接口。IDD可作为《系统/子系统设计说明》、《软件设计说明》、《数据库设计说明》的补充。IDD与其相关的《接口需求规格说明》可用于接口设计决策的交流和控制。

1851.软件研制任务书(SDTD)描述软件开发的目的、目标、主要任务、功能及性能指标等要求,是软件开发的基础和依据。其应包括下述内容:

1)运行环境要求:描述CSCI运行必需的硬件环境和软件环境的要求。

2)技术要求:描述软件的功能、性能、输入/输出、数据处理、接口、固件、关键性要求等方面的要求。

3)设计约束。

4)质量控制要求:描述软件关键性等级、标准、文档、配置管理、测试、分承制方等方面的要求。

5)验收和交付:描述软件的验收准则,软件的交付形式、数量、装载媒体,交付的文档清单和软件的版权保护等方面的要求。

6)软件保障要求。

7)进度和里程碑:包括项目的进度要求、里程碑和需要需方参加的评审等。

1852.软件开发计划(SDP)描述实施软件开发工作的计划。软件开发活动包含新开发、修改、重用、再工程、维护和由软件产品引起的其他所有活动。SDP的内容包括软件开发过程、所使用的方法、每项活动的途径、项目的进度、组织及资源的可视性和监督工具。SDP是动态的,随着项目的进展,在出现重大偏差或在里程碑处应进行分析,必要时应重新策划并修订SDP。根据实际需要,可将SDP中的某些部分编制成单独的计划。

1853.软件配置管理计划(SCMP)描述在项目中如何实施软件配置管理。其既可作为《软件开发计划》的一部分,也可单独成文。

1854.软件质量保证计划(SQAP)描述在项目中采用的软件质量保证的措施、方法和步骤。其既可作为《软件开发计划》的一部分,也可单独成文。

1855.软件安装计划(SIP)描述在用户的现场安装软件的计划。具体包括准备工作、用户培训以及从现有系统进行转换。当软件的安装需要开发人员参与,且安装过程十分复杂时,应制定SIP。

1856.软件移交计划(STrP)描述开发方向保障机构移交应交付项的计划。具体包括可交付软件生存周期所需要的硬件、软件和其他资源。

1857.软件测试计划(STP)描述对计算机软件配置项(CSCI)和软件系统或子系统进行合格性测试的计划。具体包括测试环境、要执行的测试、测试活动的进度。通常每个项目都应有一个STP。

1858.软件需求规格说明(SRS)描述对计算机软件配置项(CSCI)的需求,以及确保满足每个需求所使用的方法。SRS可由《接口需求规格说明》补充,共同构成CSCI设计与合格性测试的基础。

1859.软件设计说明(SDD)描述计算机软件配置项(CSCI)的设计。其内容包括计算机软件配置项(CSCI)级设计决策、计算机软件配置项(CSCI)体系结构设计(概要设计)和实现该软件所需的详细设计。SDD与其相关的《接口设计说明》和《数据库设计说明》共同构成软件实现的基础。

1860.数据库设计说明(DBDD)描述数据库的设计以及存取或操纵数据所使用的软件单元。它是实现数据库及相关软件单元的基础。

1861.软件测试说明(STD)描述执行计算机软件配置项(CSCI)、软件系统或子系统合格性测试所需的测试准备、测试用例及测试过程。

1862.软件测试报告(STR)是对计算机软件配置项(CSCI)、软件系统或子系统合格性测试的记录。

1863.软件产品规格说明(SPS)描述或引用可执行软件、源文件以及软件保障信息。其内容包括“已建成”CSCI的设计信息,以及编译、建立和修改规程等。是CSCI的主要软件保障文档。(www.daowen.com)

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

1865.软件用户手册(SUM)描述操作该软件的用户如何安装和使用计算机软件配置项(CSCI)、相关的CSCI、软件系统或子系统。其可能还包括软件运行的某些特殊方面的说明等。该文档也可代替《软件输入/输出手册》和《软件中心操作员手册》。其应包括如下内容:

1)软件概述:软件应用、必须安装的所有软件文件的清单、软件环境、软件组织和操作概述、意外事故及运行的备用状态和方式、保密性、帮助和问题报告等。

2)软件入门:软件的首次用户所需的信息以及软件的启动、停止和挂起等方面的规程和信息。

3)使用指南:描述使用软件的规程,包括能力、约定、处理规程、数据备份、各种消息以及错误、故障和紧急情况下的恢复等。

1866.软件输入/输出手册(SIOM)是为安装在计算机中心或在其他集中式或网络化安装场所的软件系统编制的。常与软件中心操作员手册一起使用,此时可代替软件用户手册。其应包括如下内容:

1)软件综述:描述软件应用、软件清单、软件环境、软件组织和操作概述、意外事故及运行的备用状态和方式、保密性、帮助和问题报告等。

2)使用软件:描述启动规程、输入/输出描述、输出的使用、恢复和错误纠正规程、通信诊断等。

3)查询规程:描述数据库/数据文件格式、查询能力、查询准备、控制指令等。

4)用户终端处理规程:描述使用终端完成处理的信息,包括可用的能力、访问规程、显示更新和检索规程、恢复和错误纠正规程、结束规程等。

1867.软件中心操作员手册(SCOM)是为计算机中心或在其他集中式或网络化的安装场所工作的人员,提高如何安装和操作软件系统的信息而编制的。常与《软件输入/输出手册》一起使用,此时可代替《软件用户手册》。其包括如下内容:

1)软件综述:描述软件应用、软件清单、软件环境、软件组织和操作概述、意外事故及运行的备用状态和方式、保密性、帮助和问题报告等。

2)安装和设置。

3)运行描述:描述运行清单、阶段划分、诊断规程、错误信息列表、每个运行的说明等。

1868.计算机编程手册(CPM)为程序员描述对指定计算机进行编程所需要的信息。具体包括以下内容:

1)软件编程环境:描述系统配置和操作信息,以及编译、汇编和链接所需要的设备和程序。

2)编程信息:描述编程特征、程序指令、输入和输出控制、错误检测和诊断特征以及其他编程技术等。

1869.计算机操作手册(COM)描述操作指定的计算机及其外部设备所需的信息。具体包括以下内容:

1)计算机系统操作:描述计算机系统的准备和关机、操作规程、问题处理规程等。

2)诊断特征:描述诊断特征概述、诊断规程、诊断工具集等。

1870.固件保障手册(FSM)描述对系统的固件设备进行编程和再编程所需的信息,也描述为擦除固件设备、向固件设备加载软件、验证加载过程和标记已加载的固件设备所需的固件设备和装备、软件以及规程。针对每个被编程固件设备,提供如下方面的描述:预编程设备的综述、写入设备的软件、编程设备、编程软件、编程规程、安装和修复规程、供应商信息等。

1871.软件研制总结报告(SDSR)描述软件整个研制/开发情况。具体包括:任务来源与研制依据、软件概述、软件研制过程(软件研制过程的概述以及软件研制各活动/阶段所采用的方法和工作产品等)、软件满足任务指标情况、质量保证情况(质量保证措施实施情况、软件重大技术质量问题和解决情况等)、配置管理情况(软件配置管理要求、软件配置管理实施情况、软件配置状态变更情况等)、测量和分析、结论(评述软件工程化实施情况,说明软件功能和性能指标是否满足软件任务的要求,给出软件是否可以交付使用的结论)。

1872.软件配置管理报告(SCMR)描述软件整个研制/开发过程中软件配置管理情况。具体包括:软件配置管理情况综述、软件配置管理基本信息、专业组划分及权限分配、配置项记录、变更记录、基线记录、入库记录、出库记录、审核记录、备份记录、测量。

1873.软件质量保证报告(SQAR)描述软件整个研制/开发过程中软件质量保证情况。具体包括软件研制概述、软件质量保证情况、软件配置管理情况、第三方评测情况等。

免责声明:以上内容源自网络,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。

我要反馈