软件文档模板-软件设计文档

1、（产品名称）软件设计文档玉海科技200年 月表XXX数据设计需求跟踪表需求名称标识号本文档章节号转手数据CAP103-A4. 2. 1. 1拟制:审核:玉海科技目次 TOC o 1-5 h z 1范围1标识1系统概述1文档概述2引用文档2文档约定2概要设计2CSCI 概述2CSCI 结构3系统状态和模式3容量和时间要求3CSCI设计说明3（CSC名称和工程唯一标识号）3详细设计4（CSC的名称和工程唯一标识号）4（CSU的名称和唯一标识号）4CSCI 数据5数据结构说明5全局变量说明5CSCI数据文件5需求可追踪性5（产品名称）软件设计文档PAX. XXX. XXXRM范围标识说明：列出本文档

2、的：已批准的标识号；版本号；标题；缩略语；本文档适用的 系统和计算机软件配置项（CSCD,并标识派生该CSCI需求的更高层的规格说明。例 如：标识号：XX软件设计文档:PAL203.134 RM；版本号：VI；标题：XX软件设计文档；缩略语：软件设计；本文档适用于XX的主控软件配置项。系统概述说明：概述本文档所适用的系统和CSCI的用途。非嵌入式软件还应在此说明运行 依赖的软件环境.如果涉及多个芯片或单机，应在此明确软件的驻留方式。例如：XX主要由、直接印字报（NBDP）终端等构成，实现数字选呼、遇险呼叫、数字 选呼扫描值班等功能，也可作为备用设备用于常规报务通信。收发信机主控软件主要用于接收

3、选呼终端的频率切换信息，并控制收发信机内部各 单元在正确的频率上做好工作准备。玉海科技文档概述说明：概述本文档的用途和内容。例如：本文档是收发信机主控软件的设计说明，描述了本CSCI的各模块设计，模块接口和 主要数据。本文档用于指导软件设计师编制主控软件代码，也是软件测试工程师编制测 试说明的依据。2引用文档说明：列出编写本报告时参考的文件（如经核准的计划任务书或合同、上级机关的 批文等）、资料、技术标准。至少应包括软件需求规格说明，排列时按照/企业标准/一般文档的顺序排列例如： 引用文档见表1。表1引用文档文档号标题武器系统软件开发文档XX需求规格说明文档约定列出本文档使用的其他缩略语、术语

4、和概念等。如无可注明无特殊约定。例如： 无特殊文档约定。概要设计. 1 CSC I 概述说明：描述CSCI在系统中的作用。指出CSCI的每个外部接口的用途，可以使用系 统结构图指出该CSCI和系统中其它的CSCI的相互关系.即使和需求说明类似，在此也 必须做出说明。对于外部接口有一定复杂性，又不至于要增加外部接口设计文档的，可 在4.2里面放一个小节说明。如CSCI无外部接口，也可省略.软件提供哪些应用方式，例如：组网有几种形式，可应用到哪些场合和设备中，如 何与别的设备配合以满足用户的要求。玉海科技PAX.XXX. XXXRM. 1. 1 CSC I 结构说明：描述CSCI的内部结构。应指明

5、CSC和其下一级的CSC及其用途，并描述各CSC 之间的相互关系.该关系要指出各CSC到CSC接口的用途，并概述通过接口传送的 数据.本节还应指出所有被合并到CSCI的非开发软件.本节需要详细表达CSCI内部的功能模块划分.并推荐用图来说明.对于接口协议特别简单的，可以在此说明.对于接口协议复杂的，可以用单独文档说 明.一般接口协议，可以在后面以通信接口 CSC形式加以详细说明，通常可从用户接口， 硬件接口和软件接口三方面考虑.1.2系统状态和模式说明：指出每个CSCI操作的系统状态和模式以及在此状态和模式下执行的CSC。通过流程图等形式说明CSCI内部各CSC之间的控制流程和数据流程或消息流

6、.对于一般的单片机程序，对于内部状态和中断等可以在此说明.在VxWorks上工作的软件，建议在此节说明内部的任务划分和相互间的通信方式.基于Windows工作的软件，建议在此节说明内部的进程/线程划分和相互间的交互. 1.3容量和时间要求说明：提供分配给CSC的内存和进程时间以及其它关键资源。即使和需求说明类似， 在此也必须做出说明。对于内存分配有限制，尤其是实时性有特殊要求的，以及一些特殊资源，例如某些特定的 寄存器，端口等资源的使用，需要在此节作出说明.另外如果对性能方面例如系统容量，响应时间等有需要，也可以在此说明。.2 CSCI设计说明2. 1 1 CSC的名称和工程唯一标识号1. 1

7、 CSU的名称和唯一标识号说明：对于多个CSC使用的CSU,只在一个CSC下详细描述，其它CSC只需要说明引 用即可. 1. 1. 1 . 1. 1.2 CSU的名称的设计说明:根据CSU实际情况,择要就以下方面适当裁剪进行说明A输入输出数据；B重要的内部数据；C中断和信号；D算法；E错误处理；F数据转换；G其它元素使用：调用其它函数，全局数据，输入输出缓冲等；H逻辑描述（建议使用流程图）；I数据结构：使用的全局结构和重要的内部结构玉海科技PAX.XXX. XXXRMJ数据文件和数据库使用；K局限性：目前设计实现的限制或不通用特征。CSCI数据数据结构说明说明：主要的数据结构，类定义描述，用于指导后续编码测试维护等工作全局变量说明说明：主要的全局变量描述，用于指导后续编码测试维护等工作CSCI数据文件说明：分节对所使用的数据库及使用数据库的方式作详细说明。对使用的配置文件等相关数据文件进行说明.如果物理存储有特殊要求，需要在 此说明。分小节对具体数据文件的用途，大小，访问方法，内部记录的结构和大小作出说明.建议以 图表的方式对涉及的数据项的数据类型，数据表示，大小，单位，值域，精确度等属性进 行说明.或以专门文件说明.需求可追踪性说明:如果在软件需求和