5软件文档编写及报告生成.pdfVIP

创景科技 RTCASE培训教程之 GJB438A文档编写 创景科技 内容 • 软件需求规格说明编写要点 • RTcase中需求规格说明的报告定制 • 软件设计文档编写要点 • RTcase中设计文档的报告定制 创景科技 软件需求规格说明编写要点 • 软件需求规格说明编写目的 • 软件需求规格说明的特性 • 软件需求规格说明的内容 创景科技 软件需求规格说明编写目的 • 软件需求规格说明要从以下各方面规定软件产品 的所有外部特性： – 功能，即该软件产品能做什么； – 外部接口，即该软件产品如何与系统的硬件，或其它 的硬件和软件如何相互作用； – 性能，即该软件产品的速度、响应时间、恢复正常工 作所需时间和可用性； – 属性，即该软件产品的可移植性、可维护性、保密性 等； – 设计约束，即该软件产品的开发环境、运行环境、编 程语言等。 创景科技 好的软件需求规格说明的特性 – 正确性 – 无歧义性 – 完整性 – 一致性 – 分级性 – 详细性 – 可验证性 – 可更改性 – 可追踪性 创景科技 软件需求规格说明的内容 • 1.范围（GJB438A-97软件需求规格说明第1章） • 1.1标识（GJB438A-97软件需求规格说明第1.1条） – 本条应列出本文档的： • 已批准的标识号，即本所标准化部门给出的文档编号； • 标题，例如，《UFCP软件需求规格说明》； • 本文档适用的系统/分系统和计算机软件配置项（CSCI ）。 创景科技 软件需求规格说明的内容 • 1.2 CSCI概述(GJB438A-97第1.2条) – 本条应简要描述CSCI在系统/分系统中的作用，解释该 CSCI能做什么，如有必要可说明该CSCI不能做什么。 – 可利用方框图来描述该CSCI与所处系统/分系统中其它 部件的关系。 – 本条的描述应与上一级文档（如系统规范）中的相关 描述一致。 创景科技 软件需求规格说明的内容 • 1.3 文档概述（GJB438A-97 明第1.3条） – 本条应简要描述本文档的内容和用途。 创景科技 软件需求规格说明的内容 • 2.0 引用文档（GJB438A-97第2章） – 本章应列出本文档引用的其它文档。要指明引用文档 的编号、标题、发布日期、版本号。 创景科技 软件需求规格说明的内容 • 3.0 工程需求（GJB438A-97第3章） – 本章应详细描述CSCI的工程需求，它应包括系统规范中 分配给该CSCI的需求以及由此派生的需求。 创景科技 软件需求规格说明的内容 • 3.1 CSCI外部接口需求（GJB438A-97第3.1条） – 外部接口一般包括硬件接口、软件接口、通信接口，还可能 包括用户接口。 – 关于硬件接口应详细描述软件与硬件的每一个接口。这包括 配置的特性，如端口的个数和地址、中断向量表、RAM和 ROM的地址范围等。 – 软件接口包括与实时执行软件（实时操作系统）、数学库或 其它应用软件的接口。对每一个需要接口的软件，要描述其 名称、助记符、版本号和来源。对每一个接口，要描述接口 格式和内容。如果已有详细描述接口的其它文档，则不必重 复，但要指明这些文档。 – 关于通信接口应详细描述通信规约。 – 关于用户接口应详细描述软件与