详细设计说明书(公司内部使用).doc

XX产品系列XX模块(版本号) 详细设计说明书 编制 审 目录 1. 简介 3 1.1. 编写目的 3 1.2. 背景 3 1.3. 术语和缩写 3 1.4. 参考资料 3 2. 模块说明 3 2.1. 模块描述 3 2.2. 框架流程及功能描述 3 2.3. 算法逻辑 3 2.4. 资源消耗 3 2.5. 未解决问题 4 3. 接口定义 4 3.1. 外部接口 4 3.2. 内部函数接口 4 4. 数据结构设计 4 4.1. 逻辑结构 4 4.2. 物理结构 4 4.3. 数据结构与程序的关系 4 5. 特殊处理 4 5.1. 初始化处理 4 5.2. 异常处理 5 5.3. Debug模式 5 6. 修订记录 5 简介 编写目的 说明编写这份详细设计说明书的目的，指出预期的读者。 背景 待开发软件模块的名称。 术语和缩写 术语 含 义 参考资料 模块说明 模块描述 模块编号，需参考概要设计中的编号。 对模块的功能、性能和接口需求描述。 框架流程及功能描述 详细描述模块框架中各单元的功能设计和对应的函数划分。可采用IPO图，序列图。 算法逻辑 清晰说明关键算法或逻辑，包括算法及实现细节，控制逻辑的各种分支情况，数据的流向等。 可使用流程图、PDL语言等进行分析。 资源消耗 详细说明该模块需要系统分配的各种资源，如内存、线程、文件句柄等。 未解决问题 说明在详细设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。 接口定义 外部接口 详细说明本模块与上层系统的接口详细定义，包括函数名及传递参数等。 内部函数接口 说明本模块内部各函数之间的接口定义，包括函数名及传递参数等。 数据结构设计 逻辑结构 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。 物理结构 给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存取区域）、设计考虑和必威体育官网网址条件。 数据结构与程序的关系 说明各个应用程序与访问这些数据结构的各个函数之间的对应关系，可采用如下的矩阵图的形式： 相关模块 数据结构1 函数1、函数2… 数据结构2 。。。。。。 数据结构n 特殊处理 初始化处理 异常处理 Debug模式 修订记录序号 变更时间 版本 变更人 变更说明 仅供内部使用 4