您好,欢迎访问三七文档
当前位置:首页 > 商业/管理/HR > 质量控制/管理 > 软件详细设计说明书模板
产品名称密级产品版本共11页XX详细设计说明书拟制日期yyyy-mm-dd评审人日期yyyy-mm-dd批准日期yyyy-mm-dd公司或企业图标公司或企业中英文名称版权所有侵权必究(仅供内部使用)修订记录日期修订版本DefectIDCR号修改章节修改描述作者2001-06-081.00初稿完成作者名yyyy-mm-dd1.01xxxx.x.x;y.y.y修改XXX1.Xxx2.Xxx3....作者名xxxx.x.x;y.y.y修改XXX1.Xxx2.Xxx3....yyyy-mm-dd1.02xxxx.x.x;y.y.y修改XXX1.Xxx2.Xxx3....作者名……………………yyyy-mm-dd2.00xxxx.x.x;y.y.y修改XXX1.Xxx2.Xxx3....作者名分发记录CopyNo.持有者和角色分发日期1RDPDTPDT开发代表yyyy-mm-dd2ProjectManager项目经理yyyy-mm-dd3Teammembers项目组成员yyyy-mm-dd4CustomerRepresentative客户代表yyyy-mm-dd5Others其它yyyy-mm-dd目录1简介..........................................................................................................................................61.1目的....................................................................................................................................61.2范围....................................................................................................................................62详细设计...................................................................................................................................62.1模块1详细设计....................................................................................................................62.1.1数据描述.......................................................................................................................61.简单数据描述;............................................................................................................62.结构1............................................................................................................................63.结构2............................................................................................................................72.1.2函数描述.......................................................................................................................81.函数1............................................................................................................................82.函数2............................................................................................................................92.2模块2详细设计..................................................................................................................102.3错误处理...........................................................................................................................102.3.1系统错误.....................................................................................................................102.3.2接口错误.....................................................................................................................102.3.3协议错误.....................................................................................................................10表目录Table1**表..................................................................................................错误!未定义书签。表1**表........................................................................................................错误!未定义书签。图目录Figure1Module1StructureChart模块1结构图.....................................................................8XX详细设计说明书关键词:摘要:缩略语清单:对本文所用缩略语进行说明,要求提供每个缩略语的英文全名和中文解释。缩略语英文全名中文解释1简介1.1目的描述本文的目的,一般详细设计必须能够直接指导编码活动。1.2范围本节应描述文档所包括和不包括的内容。2详细设计对于在概要设计说明书中给出的软件实体,本节集中描述它们的详细描述部分。2.1模块1详细设计描述模块中定义和使用的数据,包括:简单数据,如模块级的全局变量、常量、宏;复合数据,如模块内部的结构、联合...;2.1.1数据描述在2.1.1.1中描述本模块中的简单变量、常量、宏;从2.1.1.2起描述本模块中的复合数据,如结构、联合等;1.简单数据描述;描述在本模块中定义和使用的简单变量、常量、宏;按照下列格式进行简单数据的描述功能描述:描述该数据的用途数据定义:定义该数据2.结构1定义和说明该数据结构(包括联合);按照下列格式进行数据结构的描述数据结构描述:描述该数据结构的用途数据结构定义:用实际的编程语言定义该数据结构数据项描述:数据类型数据项定义数据项描述3.结构22.1.2函数描述本节应按照下列格式进行描述:标识:模块名称类型:模块类型,如,2级设计中的模块,1级设计中的进程功能概述:简要描述本模块功能,要和概要设计文档中相关模块分解的描述一致。函数调用关系:用层次图或结构图的方式描述函数调用关系,如:Function1Function2Function3A,BCD,EFigure1Module1StructureChart模块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,填写目的板的CPUIDif调用失败调用VOS_FreeMsg,释放pMsg的消息包空间返回M2UA_FAILURE,失败填写目的功能模块号到pMsg填上消息包的具体内容调用消息发送函数VOS_SendMsg,VOS把消息包发送到给MTP2返回M2UA_SUCCESS,成功2.函数22.2模块2详细设计2.3错误处理2.3.1系统错误描述象内存分配失败,任务创建失败等错误是如何被处理的。2.3.2接口错误描述将要产生并给外部实体用的错误码2.3.3协议错误描述在协议中没有描述的情况如何处理。(可选)参考资料清单:请罗列本文档所参考的有关参考文献和相关文档,格式如下:作者+书名(或杂志、文献、文档)+出版社(或期号、卷号、公司文档编号)+出版日期+起止页码例如:[1]D.B.Leeson,“ASimpleModelofFeedbackOscillatorNoiseSpectrum,”Proc.IEEE,pp329-330,February1966(英文文章格式)[2]D.Wolaver,Phase-LockedLoopCircuitDesign,PrenticeHall,NewJersey,1991(英文书籍格式)[3]王阳元,奚雪梅等,“薄膜SOI/CMOSSPICE电路模拟”,电子学报,vol.22,No.5,1994(中文文章格式)[4]郑筠,《MOS存储系统及技术》,科学出版社,1990(中文书籍格式)[5]XXX,SDXXX用户手册V1.1,基础部文档室,2001/4/26
本文标题:软件详细设计说明书模板
链接地址:https://www.777doc.com/doc-6233219 .html