软件文档模板-软件概要设计说明

1、（产品名称）软件概要设计说明（宋体小初）.XX公司二OXX年XX月（宋体三号）X X X X软件概要设计说明图 X XXXXXXX5.2平安性需求 5. 2. 1接口标识和接口图说明:本条应说明赋予每个接口的工程唯一的标识符，（假设适用）应通过名称、编号、 版本及文档引用来标识接口实体（软件单元、系统、配置项、用户等）。该标识应说明 哪些实体具有固定的接口特性（从而把接口需求分配给这些接口实体）;说明哪些实体 正在开发或修改（这些实体已有各自的接口需求）。（假设适用）应通过接口图来描述这些 接口。5. 2. 2 （接口唯一的工程标识符）说明:本条（从4. 3. 2开始）应通过工程唯一标识符来标

2、识接口,应简要地标识接 口实体,根据需要可分条描述单方或双方接口实体的特性。如果一指定的接口实体未包 含在本SDD中（例如,一个外部系统）,而描述接口实体需要提到其接口特性时,这些 特性应作为假设予以陈述、或以“当未涵盖的实体这样做时,所指定的实体将” 的形式描述。应包含以下内容:a）接口实体分配给的接口的优先级;b）要实现的接口类型（例如实时数据传输、数据的存储和检索等）;c）接口实体将提供、存储、发送、访问、接收的各个数据元素的特性;d）接口实体将提供、存储、发送、访问、接收的数据元素集合体;e）接口实体用于接口的通信方法的特性;f）接口实体用于接口协议的特性;g）其他特性,例如接口实体的

3、物理兼容性。. 2.3 （接口唯一的工程标识符）XXX X软件概要设计说明XXXXXXXXXXXXXXXXXXXXX；X X X X X X X；xxxxxxx；xxxxxxx；xxxxxxx；XXXXXXX；xxxxxxx；xxxxxxxoCSC I详细设计（软件单元的工程唯一的标识符，或者一组软件单元的标识符）说明:本条应通过工程唯一的标识符来标识软件单元,并对该单元进行说明。（假设适 用）该说明应包括以下信息。a）（假设有）单元设计决策,如要使用的算法（之前尚未选定）;b）该软件单元设计中的任何约束、限定或非常规特征;c）如果使用的编程语言不同于该CSCj所指定的语言,那么应指出并说明使

4、用它的理 由;d）如果该软件单元包含过程性命令或由过程性命令组成（例如数据库管理系统 （DBMS）中用于定义表单和报表的菜单项选择择,用于数据库访问和操纵的在线DBMS 查询,用于代码自动生成的图形用户接口 （GUI）构造器的输入,操作系统的命 令或Shell脚本）,应列出这些过程性命令,并引用解释它们的用户手册或其它 文档;e）如果该软件单元包含、接收或输出数据,（假设适用）应对它的输入、输出及其它 数据元素和数据元素集合体进行说明;f）如果该软件单元包含逻辑,那么给出该软件单元所用到的逻辑。2 （软件单元的工程唯一的标识符，或者一组软件单元的标识符）XXXXXXXXXXXXXXXXXXXX

5、；XXXXXXXXXXXXXXXXXXXX；xxxx软件概要设计说明XXXXXXXXXXXXXXXXXXXX；XXXXXXXXXXXXXXXXXXXX；XXXXXXXXXXXXXXXXXXXX；XXXXXXXXXXXXXXXXXXXXo7需求可追踪性说明:a)从本SDD所标识的每个软件单元，到分配给它的CSCI需求的可追踪性(这一可 追踪性也可以在4. 1条中提供)。b)从每个CSCI需求,到被分配这些需求的软件单元的可追踪性。8注释说明：背景、术语、缩略语或公式等（产品名称）软件概要设计说明（宋体二号）XXX-RM-VX. X（宋体小二）拟制：（软件设计师） （软件负责人）标审：（单位工程管

6、理员） （工程技术负责人）日期：日期：日期：日期：（宋体三号）（产品名称）软件概要设计说明（宋体二号）X X X-RM-VX. X （宋体小二）拟制：日期： 日期：标审：日期： 日期：（宋体三号）XXX X软件概要设计说明目录 TOC o 1-5 h z 1引言1标识1系统概述13文档概述1定义1基线12引用文件1CSCI级设计决策2CSCI体系结构设计2CSCI 部件21执行方案32平安性需求4CSCI详细设计56. 1 （软件单元的工程唯一的标识符，或者一组软件单元的标识符）56.2 （软件单元的工程唯一的标识符，或者一组软件单元的标识符）57需求可追踪性68注释6软件概要设计说明1引言标

7、识说明:列出嵌入本csci的（型号、分系统）目标机,本csci的完整标识（包括产 品配套表中的名称和标识号）系统概述说明:简述本CSCI和被嵌入系统的用途（如用于XXXX超XX接收机,在XX单元 中采集和转发数据）和一般特性、平安关键等级,列出相关文档。文档概述例如:编写本文件的目的是依据需求规格说明书，在体系结构的层次上对计算机软件 配置项开展设计工作。完成按照软件环境模型和行为模型划分任务，将需求分配到软件 部件，建立程序组织结构，定义各层次部件的接口设计和数据结构设计等工作。本文件 是概要设计阶段的工作成果之一，为软件的详细设计和编制集成测试计划提供依据，帮 助软件维护人员了解系统的体系

8、结构。文件的读者为本计算机软件配置项设计人员、测试人员和维护人员。定义说明:列出本文件中用到的缩略语和其他需要说明的特别术语的定义。基线说明：以编号、标题、版本（最后一次变更日期）等信息,列出进行本CSCI概要设 计阶段的输入依据。例如：XXXXXXX （标识号）XXXXXXXX单元软件需求规格说明书VX.X2引用文件说明：列出本文件引用的全部文档的文件编号、标题、发表日期和出版单位,也应 标识不能通过正常的供货渠道得到的所有文件资料的来源。X X X X软件概要设计说明表 X X X X X X X3 CSCI级设计决策编号标题编写单位修订版日期来源说明：分条给出CSCI级设计决策（忽略其内

9、部实现,从用户角度出发描述系统将怎 样运转以满足需求）和其它影响组成该CSCI的软件单元的选择与设计的决策。如果在 需求中所有这些决策是明确的,或者这些决策要推迟到CSCI的软件单元的设计时指出, 那么本章应如实陈述。例如:CSCI级设计决策的例子如下：a）关于CSCI将接收的输入和将产生的输出的设计决策；b）有关响应每个输入或条件的CSCI行为的设计决策；c）有关数据库/数据文件如何呈现给用户的设计决策；d）为满足平安性、保密性和私密性需求所选择的方法；e）为满足需求所做的其它CSCI级设计决策。CSCI体系结构设计说明：本章应分条描述CSCI体系结构设计。如果设计的全部或局部依赖于系统的状

10、 态或方式,此依赖性应予指明。如果设计信息在多于一个条中出现,它只需被提供一次, 而在其它条中引用之。应提供或引用为了理解设计所需要的设计约定。CSC I部件说明:a）构成该CSCI的所有软件单元。应赋予每个软件单元一个工程唯一标识符。XXX X软件概要设计说明b）软件单元的静态（如,由组成）关系。c）每个软件单元的用途,指明分配给它的CSCI需求和CSCI级设计决策（需求的 分配也可在6 a）中提供）。d）每个软件单元的开发状态/类型（如新开发、按原样重用已有的设计或软件、再 工程的已有的设计或软件、为重用而要开发的软件等,为构建版N计划的软件）。 针对现有的设计或软件,本说明应提供标识信息,例如名字、版本、文档引用、 库等。e） CSCI （假设适用,针对每个软件单元）计划使用的计算机硬件资源（例如处理机 能力,内存能力,输入/输出设备能力,辅存能力以及通信/网络设备能力）。5. 1执行方案说明:本条应说明软件单元间的执行方案。应采用图表和描述,