软件需求规格说明编写指南(438B)(14页).doc

-软件需求规格说明编写指南(438B)-第 10 页密级： （软件项目名称）软件需求规格说明标 识： 版 本：页 数：拟 制：SQA审核：审 核：批 准：拟制部门：XXXXXXXXXX研究所年月日修改文档历史记录：日 期版本说 明修改人目 录1 范围11.1 标识11.2 系统概述11.3 文档概述12 引用文档13 需求13.1 要求的状态和方式13.2 CSCI能力需求43.2.X（CSCI能力）43.3 CSCI外部接口需求53.3.1 接口标识和接口图53.3.X（接口的项目唯一的标识符）53.4 CSCI内部接口需求73.5 CSCI内部数据需求83.6 适应性需求93.7 安全性需求93.8 保密性需求93.9 CSCI环境需求103.10 计算机资源需求103.10.1 计算机硬件需求103.10.2 计算机硬件资源使用需求103.10.3 计算机软件需求103.11 软件质量因素113.12 设计和实现约束113.13 人员需求113.14 培训需求123.15 后勤保障需求123.16 其它需求123.17 验收、交付和包装需求（修改有关内容）123.18 需求的优先顺序和关键程度124 合格性规定125 需求可追踪性136 注释131 范围1.1 标识【本条应描述本文档所适用的系统和软件的完整标识，适用时，包括其标识号、名称、缩略名、版本号及发布号。】示例：系统标识如下：a) 已批准的标识号：b) 产品名称：XXXXXXc) 产品代号：XXXXXXd) 版本号：XXXXXe) 缩略名：1.2 系统概述【本条应概述本文档所适用的系统和软件的用途。它还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构；标识当前和计划的运行现场；列出其它有关文档。】示例：a) 软件用途：b) 系统概述：c) 需方：XXXXX d) 开发方：软件开发组e) 运行环境：XXXXXf) 相关文档：以下描述相关技术数据内容:1) 软件开发计划2) 软件研制任务书3) 。1.3 文档概述【本条应概述文档的用途和内容，并描述与它的使用有关的保密性方面的要求。】2 引用文档【本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识所有不能通过正常采购活动得到的文档的来源。】3 需求3.1 要求的状态和方式【如果要求CSCI在多种状态或多种方式下运行，并且不同的状态或方式具有不同的需求，则应标识和定义每一种状态和方式。状态和方式的例子包括：空闲、就绪、活动、事后分析、训练、降级、紧急情况、备份、战时和平时等。可以仅用状态描述CSCI，也可仅用方式、用方式中的状态、状态中的方式、或其他有效的方式描述CSCI。如果不需要多种状态或方式，应如实陈述，而不需要进行人为的区分；如果需要多种状态和/或方式，应使本规格说明中的每个或每组需求与这些状态和方式相对应，对应关系可以在本条或本条所引用的附录中，通过表格或其它方式加以指明，也可以在该需求出现的章条中加以声明。】示例：3.2 CSCI能力需求【为详细说明与CSCI各个能力相关的需求，本条可分为若干子条。“CSCI能力需求”中的“能力”为一组相关需求，可用“功能”、“主题”、“对象”、或其他适合表示需求的词替代。】示例：3.2.X（CSCI能力）【本条应标识必需的每一个CSCI能力，并详细说明与该能力有关的需求。如果该能力可以更清晰地分解成若干子能力，则应分条对子能力进行说明。需求应详细说明所需的CSCI行为，包括适用的参数，如响应时间、吞吐时间、其它时限约束、时序、精度、容量、优先级、连续运行需求和在基本运行条件下允许的偏差；适当时，需求还应包括在异常条件、非许可条件或超限条件下所需的行为，错误处理需求和任何为保证在紧急时刻运行的连续性而引入到CSCI中的规定。在确定与CSCI所接收的输入和CSCI所产生的输出有关的需求时，应考虑在3.3.X给出的要考虑的主题列表。】/* 此段引用G B_T 计算机软件文档编制规范 8567-2006对于每一类功能或者对于每一个功能，需要具体描写其输入、处理和输出的需求。a. 说明描述此功能要达到的目标、所采用的方法和技术，还应清楚说明功能意图的由来和背景。b. 输入包括：1） 详细描述该功能的所有输入数据，如：输入源、数量、度量单位、时间设定和有效输入范围等。2） 指明引用的接口说明或接口控制文件的参考资料。c. 处理定义对输入数据、中间参数进行处理以获得预期输出结果的全部操作。包括：1） 输入数据的有效性检查。2） 操作的顺序，包括事件的时间设定。3） 异常情况的响应，例如溢出、通信故障、错误处理等。4） 受操作影响的参数。5） 用于把输入转换成相应输出的方法。6） 输出数据的有效性检查。d. 输出1） 详细说明该功能的所有输出数据，例如，输出目的地、数量、度量单位、时间关系、有效输出范围、非法值的处理、出错信息等。2） 有关接口说明或接口控制文件的参考资料。示例：【CSU1】功能描述模块名称项目唯一标识号模块用途物理/数学模型模块实现功能模块性能要求子模块名称对应的分配需求容错设计需求模块输入输出输入输出名称类型用途3.3 CSCI外部接口需求【本条可分为若干个小条来规定关于CSCI的外部接口的需求（若有）。本条可引用一个或多个接口需求规格说明（IRS）或包含这些需求的其它文档。】3.3.1 接口标识和接口图【本条应标识所需要的CSCI外部接口（即，与涉及共享、提供或交换数据的其它实体的关系）。每一个接口的标识应包括项目唯一的标识符，（若适用）应通过名称、编号、版本、引用文档来指明接口实体（系统、配置项、用户等）。该标识应声明哪些实体具有固定的接口特性（要给出这些接口实体的接口需求）；说明哪些实体正在开发或修改之中（这些实体已有各自的接口需求）。应该通过一张或多张接口图来描述这些接口。】3.3.X（接口的项目唯一的标识符）【本条（从3.3.2开始）应通过项目唯一标识符来标识CSCI外部接口，应简要地标识接口实体。视需要可分小条描述为实现该接口提出的该CSCI的需求。该接口所涉及的其它实体的接口特性应作为假定予以描述，或以“当未涵盖的实体这么做时，本CSCI应该”的形式加以叙述，而不作为针对其它实体的需求。本条可引用其它文档（例如数据字典、通信协议标准、用户接口标准）代替在此所描述的信息。（若适用）需求应包括如下内容，并以任何适合于需求的顺序给出，还应从接口实体的角度说明这些特性之间的区别（例如对数据元素的大小、频率或其它特性的不同期望值）：a）CSCI必须分配给该接口的优先级；b）对要实现的接口类型的要求（例如实时数据传送、数据的储存和检索等）；c）CSCI必须提供、储存、发送、存取、接收的各个数据元素所要求的特性，例如：1) 名称/标识符：（1）项目唯一的标识符；（2）非技术（自然语言）名称；（3）数据元素名称；（4）技术名（如在代码或数据库中的变量名或字段名）；（5）缩略名或同义名。2) 数据类型（字母数字、整数等）；3) 大小和格式（如：字符串的长度和标点符号）；4) 计量单位（如：m等）；5) 可能值的范围或枚举（如：0-99）；6) 准确性（正确程度）和精度（有效数字位数）；7) 优先级别、定时、频率、容量、序列以及其他约束条件（例如数据元素是否可以被更新、业务规则是否适用）；8) 保密性约束；9) 来源（设置/发送实体）和接收者（使用/接收实体）。d）CSCI必须提供、存储、发送、访问、接收的数据元素组合体（记录、消息、文件、数组、显示、报表等）所要求的特性，例如：1) 名称/标识符：（1）项目唯一的标识符；（2）非技术（自然语言）名称；（3）技术名称（如在代码或数据库中的记录名或数据结构名）；（4）缩略名或同义名。2) 包中的数据元素及其结构（编号、顺序和成组情况）；3) 介质（例如磁盘）以及在介质上数据元素/包的结构；4) 显示和其它输出的视听特性（例如颜色、布局、字体、图标和其它显示元素、峰鸣音和亮度）；5) 包之间的关系，如排序/存取特性；6) 优先级、时序、频率、容量、序列及其它约束，例如包是否可以被更新、业务规则是否适用；7) 保密性约束；8) 来源（设置/发送实体）和接收者（使用/接收实体）。e）CSCI必须使用的接口的通信方法所要求的特性。如：1) 项目唯一的标识符；2) 通信链接/带宽/频率/介质及其特性；3) 消息格式；4) 流控制（如：序列编号和缓冲区分配）；5) 周期/非周期传送的数据传送速率，传输间隔 ；6) 路由、寻址、命名约定；7) 传输服务，包括：优先权和等级；8) 安全性/保密性考虑，如：加密、用户鉴别、隔离和审核。f）CSCI必须使用的接口的协议所要求的特性，如：1) 项目唯一的标识符；2) 协议的优先级别/层次；3) 打包，包括拆包和重新打包、路由和寻址；4) 合法性检查、错误控制和恢复过程；5) 同步，包括建立连接、保持和终止；6) 状态、标识及任何其它报告的特性。g）其它所需要的特性，例如接口实体的物理兼容性（尺寸、公差、负载和接插件的兼容性等）、电压等。】示例：表X 外部接口标识接口名称接口标识号接口简述接口文档来源文档名称章节号注：接口文档来源填入相应定义该接口的文件资料，可填写多个。3.4 CSCI内部接口需求【本条应描述施加于CSCI内部接口的需求（若有）。如果所有内部接口都留待设计时再描述，那么应在此如实陈述。如果指定了这样的需求，应考虑本文档的3.3条中描述的主题。】示例：顶层模块内部接口描述接口名称接口项目唯一标识号接口简述接口传递的信息概述例：敌我目标设别内部接口示意图表x 【功能模块名】内部接口描述接口名称接口项目唯一标识号接口简述接口传递的信息概述3.5 CSCI内部数据需求【本条应描述施加于CSCI内部数据的需求（若有），包括对CSCI中数据库和数据文件的需求（若有）。如果关于内部数据的所有决策都留待设计时再考虑，那么应在此如实陈述。如果施加了这样的需求，那么本文档的3.3.X c）和3.3.X d）条应列出需考虑的主题。】示例：CSCI数据消息数据消息描述数据消息描述项目唯一标识号名称项目唯一标识号名称项目唯一标识号CSCI数据元素CSCI数据元素要求数据元素描述数据元素格式数据元素长度测量单位极限值/值域精确度精度/分辨率名称项目唯一标识号3.6 适应性需求【本条应描述关于CSCI将提供的与安装有关的数据（如场地的经纬度或场地所在地的赋税代码）的需求（若有），应指定对要求CSCI使用的运行参数（如指明与运行有关的目标常数或数据记录的参数）的需求，这些运行数可以根据运行需要而改变。】3.7 安全性需求【本条应描述关于防止或尽可能降低对人员、财产和物理环境产生意外危险的CSCI需求（若有）。例子包括：CSCI必须提供的安全措施，以便防止意外动作（例如意外地发出一个“自动导航关闭”命令）和无动作（例如发出“自动导航关闭”命令失败）。本条还应包括关于系统的核部件的CSCI需求（若有），若适用应包括预防意外爆炸以及与核安全规则保持一致等方面的需求。】示例：表X CSCI的安全性需求CSCI的安全性需求综述CSCI的功能模块名称安全性等级安全需求描述安全需求指标注:a) 用文字或上表描述可能为避免人员、财产和物理环境等潜在危害的安全需求指标；b) 如有必要，对核心或有要求的功能模块要逐个给出其安全性描述。3.8 保密性需求【本条应描述与维护保密性有关的CSCI需求（若有）。（若适用）这些需求应包括：CSCI必须在其中运行的保密性环境、所提供的保密性的类型和级别、CSCI 须经受的保密性风险、减少此类风险所需的安全措施、必须遵循的保密性政策、CSCI必须具备的保密性责任、保密性认证/认可必须满足的准则等。】示例：表X 保密性需求CSCI保密性需求综述CSCI的功能模块名称保密性需求注：a) 用文字或上表描述为避免敏感数据可能的丢失所作的保密性需求设计；b) 如有必要，对有要求的功能模块要逐个给出其保密性需求描述。3.9 CSCI环境需求【本条应描述CSCI的运行环境需求（若有）。如在其上运行CSCI的计算机硬件和操作系统。（对计算机资源的其它需求见3.10）。】示例：表X 环境要求资源名称用途硬件/软件配置说明3.10 计算机资源需求3.10.1 计算机硬件需求【本条应描述针对本CSCI必须使用的计算机硬件的需求（若有）。（若适合）这些需求应包括：各类设备的数量；处理机、存储器、输入/输出设备、辅助存储器、通信/网络设备及所需其它设备的类型、大小、容量和其它所需的特性。】示例：表X 计算机硬件设备名称数量配置名称硬件配置说明3.10.2 计算机硬件资源使用需求【本条应描述本CSCI的计算机硬件资源使用需求（若有），例如：最大允许利用的处理机能力、内存容量、输入/输出设备的能力、辅助存储设备容量和通信/网络设备的能力。这些需求（例如陈述为每一个计算机硬件资源能力的百分比）应包括测量资源使用时所处的条件（若有）。】示例：表X 硬件资源使用要求硬件名称硬件用途硬件配置要求3.10.3 计算机软件需求【本条应描述本CSCI必须使用或必须被并入本CSCI的计算机软件的需求（若有）。例子包括：操作系统、数据库管理系统、通信/网络软件、实用软件、输入和设备仿真软件、测试软件和制造软件。要列出每一个这样的软件项的正确名称、版本和参考文档。】示例：表X 软件要求软件名称软件用途软件说明版本号参考文档3.10.4 计算机通信需求【本条应描述本CSCI必须使用的计算机通信方面的需求（若有）。例子包括：要连接的地理位置；配置和网络拓扑；传输技术；数据传送速率；网关；要求的系统使用时间；被传送/接收的数据的类型和容量；传送/接收/响应的时间限制；数据量的峰值；以及诊断特性。】示例：表X （外部接口名称）通信协议通信协议名称通信协议标识通信协议实现描述3.11 软件质量因素【本条应描述合同（或软件任务书）规定的或由较高一级规格说明派生出的软件质量因素方面的CSCI需求（若有）。例子包括有关CSCI功能性、可靠性、易用性、效率、维护性、可移植性和其它属性的定量要求。】3.12 设计和实现约束【本条应描述约束CSCI的设计和实现的那些需求（若有）。这些需求可引用相应的商用或军用标准和规范来指定。例子包括关于以下各方面的需求：a）使用一个特定的CSCI体系结构，或针对体系结构的要求，例如所要求的数据库或其它软件单元；使用标准的或现有的部件；或使用由政府/需方提供的资源（设备、信息或软件）。b）使用特定的设计或实现标准；使用特定的数据标准；使用特定的编程语言。c) 为支持在技术、威胁或使命方面预期的增长或变化，必须提供的灵活性和可扩展性。】示例：表X 设计约束CSCI设计约束综述CSCI的功能模块名称设计约束注：a) 用文字或上表指明约束CSCI 设计的其他要求，如使用特殊的处理器配置等；b) 如有必要，对有要求的功能模块要逐个给出其设计约束。3.13 人员需求【本条应描述与使用或支持本CSCI的人员有关的CSCI需求（若有），包括人员的数量、技术水平、责任期限、培训要求或其它信息。例子包括要求允许多少用户同时工作，以及嵌入的帮助和培训方面的需求；还应包括施加于CSCI的人素工程需求（若有）。（适用时）这些需求应包括对人的能力和局限性的考虑，在正常和极端条件下可预见的人为错误，以及人为错误影响特别严重的那些特定场合。例子包括对出错消息的颜色和持续时间的要求、对关键指示器或按钮的物理位置的要求，以及对听觉信号的使用要求。】3.14 培训需求【本条应描述与培训有关的CSCI需求（若有）。】3.15 后勤保障需求【本条应描述与软件保障考虑有关的CSCI需求(若有)。这些考虑可以包括：对系统维护、软件保障、系统运输方式、补给系统的要求、对现有设施的影响和对现有设备的影响。】3.16 其它需求【本条应描述上述各条未能覆盖的其它CSCI需求（若有）。】3.17 验收、交付和包装需求（修改有关内容）【本条应描述为了交付而对CSCI进行包装、加标记和处理（例如用8道磁带提交，该磁带以确定的方式加以包装并贴上标签）的需求（若有）。（若适用）可引用适当的标准。】3.18 需求的优先顺序和关键程度【本条（若适用）应描述本文档中诸需求的优先顺序、关键程度、或所赋予的指明其相对重要性的权值。例子包括，指明那些被认为对安全性或保密性至关重要的需求，以便将这些需求作特殊处理。如果全部需求同等重要，本条应如实陈述。】4 合格性规定【本条应描述所定义的合格性方法，并为第3章中的每个需求指定为确保需求得到满足所要使用的方法。可用表格形式表述该信息，或为第3章中的每个需求注明所使用的方法。合格性方法可以包括：a）演示：不需要使用仪器、专用测试设备或进行事后分析，而是依靠可见的功能操作，直接运行本CSCI或本CSCI的一部分。b）测试：使用仪器或其它专用测试设备，运行本CSCI或本CSCI的一部分，采集数据供事后分析使用。c）分析：处理从其它合格性方法获得的累积数据。例如，对测试结果进行约简、解释或推断。d）审查：对CSCI代码、文档等进行目视检查。e）特殊的合格性方法：任何针对CSCI的特殊合格性方法，例如专用工具、技术、规程、设施、验收限制。】示例：表X 合格性方法CSCI的合格性项本文档第三章小节号合格性方法合格性级别软件测试需求/计划章节号功能模块名称标识号注：详细说明用于确保满足本文档第三章中的CSCI 需求的合格性审查方法。“合格性方法”“合格性级别”A-分析 1-配置项D-演示 2-系统集成Z-检查 3-系统T-测试 4-系统安装如使用“测试”合格性方法则需说明对应的软件测试需求/计划章节号，否则该列填“无”5 需求可追踪性【本章应包含：a.）从本规格说明中的每一个CSCI需求，到所涉及的系统（或子系统，若合适）需求的可追踪性（也可以通过对第3章中的每一个需求进行注释来提供可追踪性）。注：每一个层次的系统细化都可能导致需求不能直接被追踪到较高层次。例如：一个系统体系结构设计建立了多个CSCI，可能导出关于这些CSCI如何接口的需求，而这些接口需求在系统需求中并没有被涵盖。这样的需求可以被追踪到类似于“系统实现”这样的一般需求，或被追踪到导致它们产生的系统设计决策。b）从已分配给本CSCI的每一个系统需求（或子系统需求，若合适），到所涉及的CSCI需求的可追踪性。分配给本CSCI的全部系统/子系统需求都应加以说明。追踪到包含在IRS中的CSCI需求时，可引用那些IRS。】示例：表X 需求可追踪性系统/子系统设计文件CSCI需求规格说明章节号定义的CSCI 系统需求章节号功能模块6 注释【本章应包括有助于了解文档的所有信息（例如，背景、术语、缩略语或公式）。】