软件详细设计说明书模板

《软件详细设计说明书模板》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、软件详细设计说明书模板XX详细设计说明书拟制评审人批准H期H期日期yyyy-mm-ddyyyy-mm-ddyyyy-mm-dd<公司或企业图标><公司或企业中英文名称>版权所有侵权必宄（仅供内部使用）公司或企业图标XX详细设计说明书请输入密级修订记录分发记录版权所有，侵权必宄公司或企业图标XX详细设计说明书请输入密级目录1简1.1目勺61.2范62详细设i十62.1模块1详细设计62.1.1数据描61.简单数据描62.结构163.结构2.1.2函数描81.函数182.函数292.2模块2详细设i十

2、102.3错误处a...102.3.1系统错i吴102.3.2接□错102.3.3协议错版权所有，侵权必究公司或企业图标XX详细设计说明书请输入密级表目录Tablel**表错误！未定义书签。表1**表错误！未定义书签。Figure1图目录Module1StructureChart模块1结构图8版权所有，侵权必宄公司或企业图标XX详细设计说明书请输入密级XX详细设计说明书义键词：摘要：缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。版权所有，侵权必宄公司或企业图标XX详细设计说明书请输

3、入密级描述本文的目的，一般详细设计必须能够直接指导编码活动。1.2范围本节应描述文档所包括和不包括的内容。2详细设计对于在概要设计说明书屮给出的软件实体，本节集屮描述它们的详细描述部分。2.1模块1详细设计描述模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量、宏；复合数裾，如模块内部的结构、联合2.1.1数据描述在2.1.1.1中描述本模块中的简单变量、常量、宏；从2.1.1.2起描述本模块中的复合数据，如结构、联合等；1.简单数据描述；描述在本模块中定义和使用的简单变量、常量、宏；按照下列格式进行简单数

4、据的描述功能描述：描述该数据的用途数据定义：定义该数据2.结构1定义和说明该数据结构（包括联合）；按照下列格式进行数据结构的描述数据结构描述：描述该数据结构的用途数据结构定义：用实际的编程语言定义该数据结构版权所有，侵权必究详细设计说明书版权所有，侵权必究请输入密级公司或企业图标XX数据项描述：3.结构2公司或企业图标XX详细设计说明书请输入密级2.1.2函数描述本节应按照下列格式进行描述：标识：模块名称类型：模块类型，如，2级设计中的模块，1级设计中的进程功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描

5、述一致。函数调用关系：用层次图或结构图的方式描述函数调用关系，如：Figure1Module1StructureChart模块1结构图1.函数1用以下格式描述函数Function://函数名称Description://函数功能、性能等的描述Calls://被本函数调用的函数清单DataAccessed://被访问的全局变量和数据库表DataUpdated://被修改的全局变量和数据库表Input:及参数间关系。Return:Others://输入参数说明，包括每个参数的作用、取值说明Output://对输出参数的说明。

6、//函数返回值的说明//其它说明实现：这里可以使用伪码或流程图例子：m2ua_return_tm2ua_nif_sendto_mtp2版权所有，侵权必究公司或企业图标XX详细设计说明书请输入密级/*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/if链路号不合法返回M2UA_FAILURE,失败if消息类型不正确返回M2UA_FAILURE,失败if参数指针为空返回M2UA_FAILURE，失败调用消息屮请函数VOS_AllocMsg,为临时变量pMsg屮请消息包空间if申请消息包失败返回M2UA_FAILU

7、RE,消息申请函数填写发送模块信息到pMsg调用设备管理的函数Dev_FromVspCardNoGetCpuid,填写目的板的CPUIDif调用失败调用VOS_FreeMsg，释放pMsg的消息包空间返回M2UAJ=AILURE,失败填写目的功能模块号到pMsg填上消息包的具体内容调用消息发送函数VOS_SendMsg，VOS把消息包发送到给MTP2返回M2UA_SUCCESS,成功2.函数2版权所有，侵权必宄公司或企业图标XX详细设计说明书2.2模块2详细设计2.3错误处理2.3.1系统错误描述象内存分配失败，任务创建

8、失败等错误是如何被处理的。2.3.2接U错误描述将要产生并给外部实体用的错误码2.3.3协议错误描述在协议中没有描述的情况如何处理。（可选）版权所有，侵权必究请输入密级公司或企业图标XX详细设计说明书请输入密级参考资料清单：请罗列本文档所参考的有关参考文献和相关文档，格式如下：作者+书名（或杂志、文献、文档）+出版社