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

1、（产品名称） 软件详细设计 玉海科技200年 月目次 TOC o 1-5 h z 1范围1 HYPERLINK l bookmark5 o Current Document 标识1 HYPERLINK l bookmark7 o Current Document CSCI 概述1文档概述1引用文档2文档约定2详细设计2CSC的名称和工程唯一标识号22CSCI 数据3数据结构说明3全局变量说明3CSCI数据文件3需求可追踪性3（产品名称）软件详细设计PAX. XXX. XXXXD1范围标识v说明：列出本文档的：已批准的标识号；版本号；标题；缩略语；本文档适用的 系统和计算机软件配置项（CSCI）

2、,并标识派生该CSCI需求的更高层的规格说明。例 如：标识号：XX软件详细设计XD；版本号：VI；标题：XX软件详细设计；缩略语：软件详细设计；本文档适用于XX的主控软件配置项。CSC I 概述说明：概述CSCI内部的功能模块划分.并推荐用图来说明.一般从概要设计CSCI 结构节引用例如：文档概述说明：概述本文档的用途和内容。例如：本文档是依据收发信机主控软件的概要设计，详细描述了描述各CSC内部设计，接口 和主要数据。本文档用于指导软件设计师编制主控软件代码，也是编制测试说明,进行代 码走查和单元测试的依据。玉海科技PAX.XXX. XXXXD2引用文档说明：列出编写本报告时参考的文件（如经

3、核准的计划任务书或合同、上级机关的 批文等）、资料、技术标准。至少应包括软件概要设计说明,软件需求规格说明和GJB438A排列时按照GB/GJB/ 企业标准/一般文档的顺序排列例如：引用文档见表lo表1引用文档文档号标题系统软件开发文档XX需求规格说明XX软件概要设计文档约定列出本文档使用的其他缩略语、术语和概念等。如无可注明无特殊约定。例如: 无特殊文档约定。详细设计说明：以下将按照概要设计的划分，分节描述CSC详细设计。4. 1 CSC的名称和工程唯一标识号说明：描述CSC的内部CSU的组成，并描述各CSU之间的相互关系.标识CSC与外部 以及其它CSC的接口.对于多个CSC使用的CSU,

4、只在一个CSC下详细描述，其它CSC只需要说明引用即可）4. 1. 1 CSU的名称和唯一标识号4. 1. 1. 1 4. 1. 1.2 CSU的名称的设计说明:根据CSU实际情况,择要就以下方面适当裁剪进行说明A输入输出数据;2玉海科技B重要的内部数据；C中断和信号；D算法；E错误处理；F数据转换；G其它元素使用：调用其它函数，全局数据，输入输出缓冲等;H逻辑描述（建议使用流程图）；I数据结构：使用的全局结构和重要的内部结构J数据文件和数据库使用；K局限性：目前设计实现的限制或不通用特征。CSCI数据数据结构说明说明：主要的数据结构，类定义描述，用于指导后续编码测试维护等工作全局变量说明说明

5、：主要的全局变量描述，用于指导后续编码测试维护等工作CSCI数据文件说明：分节对所使用的数据库及使用数据库的方式作详细说明。对使用的配置文件等相关数据文件进行说明.如果物理存储有特殊要求，需要在 此说明。分小节对具体数据文件的用途，大小，访问方法，内部记录的结构和大小作出说明.建议以 图表的方式对涉及的数据项的数据类型，数据表示，大小，单位，值域，精确度等属性进 行说明.或以专门文件说明.需求可追踪性玉海科技说明:如果在软件需求和接口需求规格说明里面对CSC/CSU需求有详细描述，在此可以 用图表等方式提供一个全景浏览,将相关工程和CSU/CSC 一一对应,便于以后的需 求控制.如果需求规格说明里面没有作详细描述，