软件详细设计报告模板.docxVIP

XX软件详细设计报告

拟制人

日期

评审人

日期

批准人

日期

修订记录

日期

修订版本

修改位置

修改描述

修改人

目录

TOC\o1-2\h\z\u1 范围 4

2 术语、定义和缩略语 4

2.1 术语、定义 4

2.2 缩略语 4

3 详细设计 4

3.1 模块1详细设计 4

3.2 模块2详细设计 7

3.3 错误处理 7

4 参考文献 7

范围

本文件描述了XX（产品型号、规格）XX（产品名称）的……。

术语、定义和缩略语

术语、定义

要求：逐项列出本文中用到的难以理解或可能引起混淆的术语及其定义。

缩略语

要求：逐项列出本文中用到的缩略语及其原文和汉语含义。

缩略语

英文全名

中文解释

详细设计

对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。

模块1详细设计

描述模块中定义和使用的数据，包括：

简单数据，如模块级的全局变量、常量、宏；

复合数据，如模块内部的结构、联合...；

数据描述

简单数据描述

描述在本模块中定义和使用的简单变量、常量、宏；

按照下列格式进行简单数据的描述

功能描述：描述该数据的用途

数据定义：定义该数据

结构1

定义和说明该数据结构(包括联合);

按照下列格式进行数据结构的描述

数据结构描述：描述该数据结构的用途

数据结构定义：用实际的编程语言定义该数据结构

数据项描述：

数据类型

数据项定义

数据项描述

结构2

函数描述

本节应按照下列格式进行描述：

标识：模块名称

类型：模块类型，如，2级设计中的模块，1级设计中的进程

功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。

函数调用关系:用层次图或结构图的方式描述函数调用关系，如：

模块1结构图

函数1

用以下格式描述函数

Function://函数名称

Description://函数功能、性能等的描述

Calls://被本函数调用的函数清单

DataAccessed://被访问的全局变量和数据库表

DataUpdated://被修改的全局变量和数据库表

Input://输入参数说明，包括每个参数的作用、取值说明及参数间关系。

Output://对输出参数的说明。

Return://函数返回值的说明

Others://其它说明

实现：这里可以使用伪码或流程图

例子:

m2ua_return_tm2ua_nif_sendto_mtp2

/*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/

if链路号不合法返回M2UA_FAILURE，失败

if消息类型不正确返回M2UA_FAILURE，失败

if参数指针为空返回M2UA_FAILURE，失败

调用消息申请函数VOS_AllocMsg，为临时变量pMsg申请消息包空间

if申请消息包失败返回M2UA_FAILURE，消息申请函数

填写发送模块信息到pMsg

调用设备管理的函数Dev_FromVspCardNoGetCpuid，填写目的板的CPUID

if调用失败

调用VOS_FreeMsg，释放pMsg的消息包空间

返回M2UA_FAILURE，失败

填写目的功能模块号到pMsg

填上消息包的具体内容

调用消息发送函数VOS_SendMsg，VOS把消息包发送到给MTP2

返回M2UA_SUCCESS，成功

函数2

模块2详细设计

错误处理

系统错误

描述象内存分配失败，任务创建失败等错误是如何被处理的。

接口错误

描述将要产生并给外部实体用的错误码

协议错误（可选）

描述在协议中没有描述的情况如何处理。（可选）

参考文献

请罗列本文档所参考的有关参考文献和相关文档，格式如下：

作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期