LLD详细设计说明文书模板.docx

《LLD详细设计说明文书模板.docx》由会员分享，可在线阅读，更多相关《LLD详细设计说明文书模板.docx（6页珍藏版）》请在优知文库上搜索。

1、产品名称密级产品版本共6页XX详细设计说明书拟制日期yyyy-mm-dd评审人日期yyyy-mm-dd批准日期yyyy-mm-ddV公司或企业图标公司或企业中英文名称版权所有侵权必究（仅供内部使用）修订记录日期修订版本DefectlDCR号修改章节修改描述作者2001-06-081.00初稿完成作者名yyyy-mm-dd1.01XXXX.X.X；yyy修改XXX1. Xxx2. Xxx3. .作者名XXXX.X.X；yyy修改XXX1. Xxx2. Xxx3. .yyyy-mm-dd1.02XXXX.X.X；yyy修改XXX1. Xxx2. Xxx3. .作者名+yyyy-mm-dd2.00X

2、XXX.X.X；yyy修改XXX1. Xxx2. Xxx3. .作者名分发记录CopyNo.持有者和角色分发日期1RDPDTPDT开发代表yyyy-mm-dd2ProjectManager工程经理yyyy-mm-dd3Teammembers工程组成员yyyy-mm-dd4CustomerRepresentative客户代表yyyy-mm-dd5Others其它yyyy-mm-dd目录1简介31.1目的31.2范围32详细设计32.1模块!详细设计32.1.1数据描述31.简单数据描述；32.构造133.构造242.1.2函数描述41.函数142.函数252.2模块2详细设计52.3错误处理52

3、.3.1系统错误52.3.2接口错误52.3.3协议错误5表目录Tablel*表错误!未定义书签。表1*表错误!未定义书签。图目录Figure!Module1StructureChart模块1构造图4XX详细设计说明书关键词:摘要：缩略语清单：对本文所用缩略语进展说明,要求提供每个缩略语的英文全名和中文解释。缩略语英文全名中文解释1 简介1.1 目的描述本文的目的,一般详细设计必须能够直接指导编码活动。1.2 范围本节应描述文档所包括和不包括的内容。2 详细设计对于在概要设计说明书中给出的软件实体,本节集中描述它们的详细描述局部。2.1 模块1详细设计描述模块中定义和使用的数据,包括:简单数据

4、,如模块级的全局变量、常量、宏;复合数据,如模块内部的构造、联合；2.1.1 数据描述在2.1.1.1中描述本模块中的简单变量、常量、宏;从2.1.12起描述本模块中的复合数据,如构造、联合等;1 .简单数据描述；描述在本模块中定义和使用的简单变量、常量、宏;按照以下格式进展简单数据的描述功能描述:描述该数据的用途数据定义:定义该数据2 .构造1定义和说明该数据构造（包括联合）；按照以下格式进展数据构造的描述数据构造描述:描述该数据构造的用途数据构造定义:用实际的编程语言定义该数据构造数据项描述:数据类型数据项定义数据项描述3.构造22.1.2 函数描述本节应按照以下格式进展描述:标识:模块名

5、称类型:模块类型,如,2级设计中的模块,1级设计中的进程功能概述:简要描述本模块功能,要和概要设计文档中相关模块分解的描述一致。函数调用关系:用层次图或构造图的方式描述函数调用关系,如:Figure1Module1StructureChart模块1构造图1 .函数1用以下格式描述函数Function:/函数名称Description:函数功能、性能等的描述Calls:被本函数调用的函数清单DataAccessed:/被访问的全局变量和数据库表DataUpdated:/被修改的全局变量和数据库表Input:输入参数说明,包括每个参数的作用、取值说明及参数间关系。Output:/对输出参数的说明。

6、Return:/函数返回值的说明Others:/其它说明实现:这里可以使用伪码或流程图例子:m2ua_return_tm2ua_nif_sendto_mtp2/*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/H链路号不合法返回M2UAFAI1.URE,失败if消息类型不正确返回M2UA_FA11.URE,失败if参数指针为空返回M2UA_FA11.URE,失败调用消息申请函数VOS_AllocMsg,为临时变量PMSg申请消息包空间if申请消息包失败返回M2UA_FN1.URE,消息申请函数填写发送模块信息、到PMSg调用设备管理的函数Dev_FromVspCardNoGetCp

7、uid,填写目的板的CPUlDif调用失败调用VOS_FreeMsg,释放PMSg的消息包空间返回M2UA_FAI1.URE,失败填写目的功能模块号至gMsg填上消息包的具体内容调用消息发送函数VoS_SendMsg,VOS把消息包发送到给MTP2返回M2UA_SUCCESS,成功2 .函数22.2 模块2详细设计2.3 错误处理2.3.1 系统错误描述象内存分配失败,任务创立失败等错误是若何被处理的。2.3.2 接口$昔误描述将要产生并给外部实体用的错误码2.3.3 协议错误描述在协议中没有描述的情况若何处理。（可选）参考资料清单：请罗列本文档所参考的有关参考文献和相关文档,格式如下:作者+

8、书名（或杂志、文献、文档）+出版社（或期号、卷号、公司文档编号）+出版日期+起止页码例如:1 D.B.1.eeson,ASimpleModelofFeedbackOscillatorNoiseSpectrum,fProc.IEEE,pp329-330,February1966XW式）2 D.Wolaver,Phase-1.ocked1.oopCircuitDesign,PrenticeHall,NewJersey,1991英文书籍格式）3王阳元，奚雪梅等,“薄膜SOvCMoSSPlCE电路模拟”，电子学报,vol.22,No.5,1994（中文文章格式）4郑筠,?MOS存储系统及技术？,科学出版社,1990（中文书籍格式）XXX,SDXXX用户手册V1.1,根基部文档室,2001/4/26