详细设计模板.doc

项目名称： 项目编号： 第 版 文档编号：项目编号_DD_流水号 第 册/共 册 详细设计 版本：Ver 0.1 大连东软软件人才培训中心 总页数 正文 附录 生效日期 编制： 审批： 修订记录 日期 版本 说明 作者 目录 1. 引言 1 1.1 术语 2 1.2 缩略语 2 2. 模块概述 3 3. 模块的功能点 3 4. 使用的系统资源 4 4.1 ROM/RAM使用量 4 4.2 中断的定义和使用 4 4.3 TIMER资源的使用 4 4.4 OS资源的使用 4 4.5 使用的其他资源 4 5. 限制条件 4 6. 模块详细设计 5 6.1 文件一览 5 6.2 函数一览 5 6.3 函数调用关系 6 6.4 宏定义 6 6.5 消息一览 7 6.6 数据类型定义 7 6.7 全局变量定义 7 6.8 数据表设计 7 6.9 接口函数设计 8 6.9.1 函数1（实际函数名） 8 6.9.2 函数2 9 6.10 内部函数设计 9 6.10.1 函数1（实际函数名） 9 6.10.2 函数2 9 6.10.3 函数3 10 7. 附件 11 7.1 模块技术点整理 11 7.2 参考文档 11 引言 说明： 简短的描述一下文档的用途、范围以及预期读者。 注意：本模板用于编写模块级软件设计文档。进行软件设计之前应该已经完成整个系统（对于小型系统而言）或上一级模块（对于大型系统而言）的概要设计。 本模版列出了模块详细设计时需要做的比较完全的内容、可以根据项目情况适当进行裁剪。 模板格式说明： 蓝色斜体字：是模板的说明文字，实际写文档的时候需要去掉。 紫色斜体字：是模板的例子，实际写文档的时候需要去掉。 图表全部使用引用题注和交叉引用的方式、通过更新域、可以自动排序。  术语 说明： 列出文档中使用的相关术语。 例： 表 11：技術用語 番号 用語 説明 1 UART Universal Asynchronous Receiver Transmitter。 缩略语 说明： 按字母顺序列出文档中使用的缩略语。 例： 表 12：缩略语 番号 原词 缩写 説明 1 MAINGUI Module UI MAIN側GUI Module 模块概述 模块结构图 描述一下该模块的结构，比如包含哪些子模块，并介绍各子模块的功能。 模块的功能点 说明： 模块的功能点 变更或新规的功能点 例： 3.1本模块实现机能点(最好不要和标题编号使用相同的数字，可以按照第二层次标题格式来写) ■实现送信Command画面。 ■Media Module側のCommand応答データを表示する画面の作成。 ■Media Module側のStatus情報を表示する画面作成。 ■表示データ的存储。 模块详细设计 类一览 例： 表 81：类一览表 类名 描述 Class1 类功能描述 Class2 类功能描述 Class3 类功能描述 类设计 类图 宏定义 例： ucPowerStatus (Power状态变量)使用的宏定义一览 表 84：ucPowerStatus使用宏定义一览表 宏名 值 描述 POWER_ON 0x00 POWER_OFF 0x01 POWER_TRANSFER 0x02 ucPowerTable (PowerTable使用的索引定义)使用的宏定义一览 表 85：ucPowerTable使用宏定义一览表 宏名 值 描述 POWER_TBL_INIT 0x00 POWER_TBL_POWER_ON_PRO 0x01 POWER_TBL_POWER_OFF_PRO 0x02 消息一览 例： 表 86：xxx模块消息接口一览表 消息定义 值 源模块 目标模块 描述 数据类型定义 说明： 自定义的数据类型、主要指结构体。 表 87：xxx数据类型一览表 类型名 描述 全局变量定义 说明： 模块中使用到的全局变量。 表 88：xxx模块全局变量一览表 变量名 类型 描述 数据表设计 说明： 开发过程中制作的数据表格、Matrix等、如果word方式难于描述、可以些附加文档。 接口函数设计 说明： 详细描述本模块提供的接口的函数。此章节为他模块提供IF使用指导信息。 函数1（实际函数名） 说明： 关于函数流程、可以画