软件设计文档模板..docx

《软件设计文档模板..docx》由会员分享，可在线阅读，更多相关《软件设计文档模板..docx（9页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、文档代号阶段软盘编号密级（软件产品代号）（软件名称）软件设计文档编写校对审核会签标审批准XX公司内容提要:主题词更改栏更改单号更改日期更改人更改标记1 范围51.1 系统概述51.2 文档概述51.3 术语解释5引用文档52 概要设计51.1 CSCI 概述51.2 CSCI设计说明64详细设计64 .X （CSC的名称或工程唯一标识号）7CSCI 数据85 CSCI数据文件95.1 CSC / CSU数据文件的交叉引用95.2 （数据文件名和工程唯一标识号）9需求可追踪性9格式说明：(1)目录显示级别：2级一级标题：黑体，小四，段前0.5行，段后。行，行距22磅(3)正文：宋体& Times

2、 New Roman,小四，行距22磅(4)二级标题同正文(5)表题、图题：黑体，五号，居中(6)表文：宋体& Times New Roman,五号1范围系统概述概述本文档所适用的系统和CSCI的用途。1.1 文档概述概述本文档的用途和内容。1.2 术语解释对特殊名词术语的解释。2引用文档按文件号和标题列出本文档引用的所有文件。3概要设计分条描述CSCI的概要设计。3.1. CSCI 概述描述CSCI在系统中的作用，指出CSCI的每个外部接口的用途，可以使用 系统结构图指出该CSCI和系统中其它的CSCI的相互关系。3.1.1 CSCI 结构描述CSCI的内部结构，应指明计算机软件部件（CSC

3、）和其下一级的CSC 及其用途，并描述各CSC间的相互关系。该关系要指出各CSC到CSC接口的 用途，并概述通过接口传送的数据。本条还应指出所有被合并到CSCI的非开发 软件。CSCI顶层结构可以用图表示。3.1.2 系统状态和模式指出每一个CSCI操作的系统状态和模式以及在这一状态和模式下执行的 CSCo并通过列举每一个CSC执行的系统状态和模式来说明CSCI状态表。另外, 本条应描述在不同状态和模式下各CSC之间执行的控制流程和数据流程，可使 用流程图说明在每个状态和模式下的执行的控制流和数据流。3.1.3 内存和进程时间分配提供分配给CSC的内存和进程时间。并通过一个内存/进程时间表来描

4、述 此分配（参见表1 ）。表1 CSC内存/处理时间量表例如3.2 CSCI设计说明CSC名称CSC号内存预算（WORDS）分配的进程时间模式控制251, 700128.0ms雷达控制263, 00096.0ms武器控制272, 100100.0ms目标占用111, 70010.0ms执行11, 20080.0ms数据库1002, 000N/A其它69900156.0ms总计12, 600570ms可使用量16, 384740ms余留量23%23%分条提供CSCI中的每一个CSC的设计说明。3.2. X （CSC的名称和工程唯一标识号）从321条开始编号，各节应指出CSC的名称和工程唯一标识号

5、及其用途。各条应提供以下信息：a）标识由需求规格说明分配给CSC的需求。如果CSC是由下一级的一些 CSC组成的，那么可以引用下一级的CSC描述局部信息或全部信息；b）利用执行控制流和数据流来描述CSC的概要设计。如果CSC是由下一 级的一些CSC组成，应标识下一级各CSC之间的相互关系。另外，应 在软件需求规格说明文档中标识每个CSCI的内部接口。内部接口应由 CS和它的下一级CSC定位;C）描述CSC的设计需求和设计约束，如果CSC是由下一级的一些CSC组 成，那么可引用下一级的CSC的局部信息和全部信息。3.3. X.Y （下一级CSC的名称和工程唯一标识号）从3211条开始编号，标识下

6、一级的CSC的名称和工程唯一标识号及其用 途，以及提供中c项所需要的信息。如果没有下一级CSC,就不用写这一 条。如果CSC也是由下一级CSC组成的，要标识每个CSC的名称和工程唯一 标识号。而且，下一级的CSC都要用单独一节来描述中C项所要求的信息。4详细设计分条描述每个CSC的详细设计。4.X（CSC的名称或工程唯一标识号）从4.1条开始编号。分条标识和描述CSC的每一个计算机软件单元（CSU）。 用CSU间的控制流和数据流描述CSU间的关系。并标识CSC与外部联接的所 有接口。对于那些被多个CSC使用的CSU,应详细地描述在一个CSC下的情况, 其它的CSC只需要引用。4.X.Y （CS

7、U的名称和工程唯一标识号）从条开始编号。标识CSU的名称和工程唯一标识，并指出CSU的用 途。可以再分条提供CSU的设计信息。（ C S U的名称）的设计及约束从条开始编号。指出CSU的设计需求。标识分配给CSC的需求，这 些需求应是由CSU全部或局部满足。另外，还要标识CSU设计中的所有约束条 件。在该节定义的设计需求应包括人一机接口的设计需求。4.X.Y.2 （CSU的名称）的设计从4.LL2条开始编号，给出CSU的设计说明。如果CSU不是用CSCI规定 语言编写，那么要标识这一程序语言，并且阐述使用该语言的基本原理。如果 CSU保存在库中，那么各节要标识库的名称和工程唯一的标识号以及描述

8、该库的 设计文档。下面给出CSU详细的设计信息，这些信息可以通过自动化工具或其 它技术提供，例如程序设计语言、流程图或其它设计方法。a）输入/输出数据元素。标识并指出每个输入/输出数据元素的用途。数 据元素的设计信息将在本文档第5章提供；b）局部数据元素。标识并指出每个在CSU中产生的并且不被其它CSU所 使用的数据元素的用途。每个数据元素可用名称、简单的描述、数据类 型、数据表示、大小、度量单位、极限值/值域、精确度、精度/分辨 率以及任何其它的数据属性。这些信息可以在CSU局部数据定义表中 提供；C）中断和信号。标识和描述CSU处理的中断和信号。同时，要标识每个 中断和信号的信号源、用途、

9、优先级、期望响应及响应时间、最小值、 最大值和发生的概率；d）算法。标识和简述CSU的功能，详细地描述CSU的执行算法。算法可 以用输入操作和局部数据元素以及产生输出数据元素来描述；e）错误处理。标识和描述CSU的错误诊断和恢复特征，包括对错误的输入数据和影响csu执行的其它条件的处理;f）数据转换。标识和描述为实现CSU的接口要执行的数据转换操作；g）其它元素的使用。描述CSU所使用的其它元素的用途，它包括，但不 仅限于：其它CSU （例如：库函数调用、访问数据库的I/O服务调用、大容量 存储设备以及实时I/O通道）；.全局内存的共享存储数据（例如：数据库或数据文件、表、公用池、 数据池等等

10、）；输入输出缓冲，包括信息缓冲；h）逻辑流程图。根据a到g项描述CSU的逻辑流程，并描述CSU执行时 初始化的条件、调用的通信接口的特征以及其它CSU控制条件。假设在 CSCI的操作期间序列是被动态的控制，那么应描述控制的方法和该方法 的逻辑和输入条件，例如时间变化、优先级赋值、诸如输入/输出、内 部存储器的数据传送的内部操作、离散输入信号的读出以及与CSCI的 中断操作的时间关系；i）数据结构。描述CSU实现的局部数据结构以及CSU所使用的所有共享 数据结构；j）局部数据文件和数据库。如果数据文件或数据库是csu的局部数据的一 局部，那么应指出每个数据文件或数据库的用途，并用记录、字段等术

11、语描述该文件或数据库的结构和访问过程（顺序的或随机的）；k）局限性。描述限制CSU性能的局限性或不通用特征。5 CSCI数据描述CSCI的全局数据元素。为便于可读和易维护，可用一个或几个表提供 如下信息，这些信息可提供给所有的数据元素。a） CSCI内部的数据元素： 数据元素的名称； 简要描述； 测量单位，例如秒、米等； 数据元素值的极限值/值域（对常数要给出实际值）； 数据元素要求的精确度； 精度/分辨率（用有效数字表示）； 对于实时系统，计算或刷新数据元素的频率，如10kHz、50ms等； 数据元素的合法性检查； 数据类型，如整型、字符、定点数、实型、枚举型等等； 数据表示/格式； 对数据

12、元素设置值或做赋值计算的CSU的工程唯一标识号； 数据元素的CSU的工程唯一标识号；数据的来源，例如数据库或数据文件、全局公共块、局部公共块、公用池、 数据池、参数等等。每个数据的来源都要用它的工程唯一标识号标识；b） CSCI外部接口的数据元素应是： 标识数据元素； 用名称和工程唯一标识号标识接口； 引用描述外部接口的接口设计文档。6 CSCI数据文件分条描述CSCI的每个共享数据文件。6. 1 CSC/CSU数据文件的交叉引用为CSC和CSU使用以下每个数据文件提供一个映象。6. 2（数据文件名和工程唯一标识号）用名称和工程唯一标识号标识被多个CSU共享的CSCI数据文件。并陈述数 据文件的用途，标识文件的最大尺寸，描述文件的访问方法，（如随机的或顺序 的）。还应提供文件中各记录的结构和大小，描述驻留在文件中的数据：数据类 型、数据表示、大小、度量单位、极限值/值域、精确度、精度/分辨率以及数 据的其它属性。7需求可追踪性应提供分配给每个CSC的上一级CSU,可追溯到软件需求规格说明和接口需 求规格说明要求的需求。可追踪性可以用流程图来表示。