范例-软件设计说明(详细部分)的知识.doc

软件设计说明 时间 版本号 修改人 修改内容 审批人  目 录 1 范围 1 1.1 标识 1 1.2 系统概述 1 1.3 文档概述 1 2 引用文档 1 3 CSCI 级设计决策 1 4 CSCI 体系结构设计 2 4.1 CSCI 部件 2 4.2 执行方案 3 4.3 接口设计 3 4.3.1 接口标识和接口图 3 4.3.x （接口的项目唯一标识符） 4 5 CSCI 详细设计 6 5.x （软件单元的项目唯一标识符，或者一组软件单元的标志符） 6 6 需求可追踪性 7 7 注解 7 附录A 7 软件设计说明 范围 标识 要求：本节应包含这个文档所适用的系统和软件的完全标识，（若适用）应包括标识号、名称、缩略名、版本号及发布号。 系统概述 要求： 1）本节主要描述本文档适用的系统和软件的用途； 2）概述系统开发、运行和维护的历史； 3）标识项目的投资方、需方、用户、开发方和保障机构； 4）标识当前和计划的运行现场； 5）列出其它有关文档。 文档概述 本节应概述本文档的用途和内容，描述与它的使用有关的必威体育官网网址性或私密性考虑。 引用文档 列出引用的所有文档，包括文档的编号、标题、修订版本和日期。 CSCI 级设计决策 要求：本章应根据需要分节给出CSCI 级设计决策，即CSCI 行为设计的决策（忽略其内部实现，从用户角度出发描述系统将怎样运转以满足需求）和其它影响组成该CSCI 的软件单元的选择与设计的决策。如果在需求中所有这些决策是明确的，或者这些决策要推迟到CSCI 的软件单元的设计时指出，则本章应如实陈述。 针对关键性需求（例如对安全性、必威体育官网网址性、私密性等需求）作出的设计决策，应在专门的章节中加以叙述。 CSCI 级设计决策的例子如下： 1）关于CSCI 将接收的输入和将产生的输出的设计决策，包括与其它系统、HWCI、CSCI 和用户的接口（本文档的4.3.x 节指出本说明要考虑的主题）； 2）有关响应每个输入或条件的CSCI 行为的设计决策，包括CSCI 要执行的动作、响应时间和其它性能特性，模型化的物理系统的说明，选定的方程式/算法/规则，以及对不允许的输入或条件进行的处理； 3）有关数据库/数据文件如何呈现给用户的设计决策（本文档的4.3.x 节标识了本说明要考虑的主题）。如果这一信息的全部或部分在数据库设计说明（DBDD）中给出，则可直接引用； 4）为满足安全性、必威体育官网网址性、私密性需求所选择的方法； 5）为满足需求所做的其它CSCI 级设计决策，例如为提供所需的灵活性、可用性和可维护性所选择的方法。 【提示：本章主要是要求从整体（系统/子系统级别）架构设计的层面，分不同视角（功能划分、性能、可靠性、安全性、灵活性、可维护性等）确定相应的关键设计机制，从而最终确定系统/子系统级别的体系结构设计。】 CSCI 体系结构设计 要求：本章应分为以下几节来描述CSCI 体系结构设计。如果设计信息在多于一个节中出现，它只需被提供一次，而在其它节中引用之。 【提示：对各个CSCI（子系统）进行概要设计，拆分出各子系统包含的软件部件（模块）和各个软件部件包含的软件单元（子模块）。】 以下4.1节分别对各个软件部件进行静态结构说明，4.2节对各个软件部件和软件单元进行动态行为关系说明。 CSCI 部件 要求：本节应： 1）标识构成该CSCI 的所有软件单元。应赋予每个软件单元一个项目唯一标识符； 【注：软件单元是CSCI 设计中的一个元素；例如，CSCI 的一个主要分支、该主要分支的一个组成部分，一个类、对象、模块、函数、例程或数据库。软件单元可以出现在层次结构的不同层上，且又可以由其它软件单元组成。在设计中，软件单元与实现它们的代码和数据实体（例程，过程，数据库，数据文件等），或与包含这些实体的计算机文件之间，可以有、也可以没有一对一的对应关系。一个数据库可被处理为一个CSCI 也可被处理为一个软件单元。SDD 可以采用与所使用设计方法相一致的任何名字来称呼软件单元。】 2）给出软件单元的静态（如，由…组成）关系。根据所选择的软件设计方法学，可以给出多种关系（例如，采用面向对象的设计方法时，本节既可给出类和对象结构，也可给出CSCI 的模块和过程结构）； 3）说明每个软件单元的用途，指明分配给它的CSCI 需求和CSCI 级设计决策（需求的分配也可在6.a 中提供）； 4）标识每个软件单元的开发状态/类型（如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要