华为软件详细设计模板

1、产品名称Productname密级Confidentialitylevel产品版本ProductversionTotal14pages共14页XXLowLevelDesignSpecificationXX详细设计说明书PreparedbyName+IDDateyyyy-mm-dd拟制姓名+工号日期ReviewedbyDateyyyy-mm-dd评审人日期ApprovedbyDateyyyy-mm-dd批准日期XXXXCo.,Ltd.XXXX有限公司RevisionRecord修订记录Date日期RevisionVersion修订版本CRID/DefectIDCR号SecNo.修改早下Chang

2、eDescription修改描述Author作者1.1.Catalog目录1 Introduction简介71.1 Purpose目的71.2 Scope范围72 DetailedDesign详细设计72.1 Module1DetailDesign模块1详细设计72.1.1 DataDescription数据才苗述72.1.2 FunctionDescription函数描述102.2 Module2DatailDesign模块2详细设计132.3 ErrorProcess错误处理132.3.1 SystemError系统错误132.3.2 InterfaceError接口错误132.3.3 P

3、rotocolError协议错误13TableList表目录Table1*表错误！未定义书签。表1*表错误！未定义书签。FigureList图目录Figure1Module1StructureChart模块1结构图10XXLowLevelDesignSpecificationXX详细设计说明书Keywords关键词：Abstract摘要：Listofabbreviations缩略语清单：对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChin

4、eseexplanationshouldbeprovided.Abbreviations缩略语Fullspelling英义全名Chineseexplanation中文解释Introduction简介Purpose目的Todescriptthepurposeofthisdocument.Ingeneral,LLDspecificationcanbeusedtoguidethecodingactivitiesdirectly.描述本文的目的，一般详细设计必须能够直接指导编码活动。Scope范围Thissectionshouldaddressareaswhichthisdocumentinclude

5、sandthatarespecificallyexcludes.本节应描述文档所包括和不包括的内容。DetailedDesign详细设计ThissectionshouldfocusonthedescriptionofthedetaileddesignofthesoftwareentitiesthatareapartofthesoftwarebeingdescribedbytheHLDSpecification。.对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。Module1DetailDesign模块1详细设计Describedatathatdefinedorusedin

6、themodule,including:simpledatai.e.globalvariable,constantormacrowithinthemodule;complexdatai.e.Structureorunion.描述模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量、宏；复合数据，如模块内部的结构、联合.；DataDescription数据描述Describesimplevariables,constantormacroofthemoduleinsection2.1.1.1;Describecomplexdatafromsection2.1.1.2,suchasstr

7、ucture,union;在2.1.1.1中描述本模块中的简单变量、常量、宏；从2.1.1.2起描述本模块中的复合数据，如结构、联合等；SimpleDataDescription简单数据描述describesimplevariables、constantormacrousedordefinedinthismodule;描述在本模块中定义和使用的简单变量、常量、宏；Describessimplevariables,constantsusedordefinedinthismodule;Thedescriptionofsimpledatashouldfollowtheformatbelow:Func

8、tionDescription:DescribingtheusageofthedataDataDefinition:Definingthedata按照下列格式进行简单数据的描述功能描述：描述该数据的用途数据定义：定义该数据Structure1结构1DefineanddescribetheDatastructure(includeunion)定义和说明该数据结构(包括联合)；Thedescriptionofdatastructureshouldfollowtheformatbelow:DataStructureDescription:Describingtheusageofthedatastru

9、ctureDataStructureDefinition:DefiningthedatastructurewiththeactualprograminglanguageDataItemsDescription:DataTypeDataItemDefinitionDataItemDescription按照下列格式进行数据结构的描述数据结构描述：描述该数据结构的用途数据结构定义：用实际的编程语言定义该数据结构数据项描述:2.1.2FunctionDescription函数描述Thissectionshouldfollowtheformatbelow:Identification:Titleofth

10、emoduleType:Typeofthemodule,forexample,themoduleinLevel2Design,theprocessinLevel1Design,etc.FunctionDescription:Describingthefunctionsofthemoduleinbrief,whichshouldbeconsistentwiththerelatedsectioninHLDdocuments.FunctionInvokingRelation:UsingtheHierarchyChartorStructureCharttodescribeit,forexample:本

11、节应按照下列格式进行描述：标识：模块名称类型：模块类型，如，2级设计中白模块，1级设计中的进程功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。函数调用关系：用层次图或结构图的方式描述函数调用关系，如：Figure1Module1StructureChart模块1结构图Function1函数1Descriptthefunctionasfollows;Function:/nameoffunctionDescription:/functionalityofthefunctionCalls:/functionlistswhichcalledbythisfunctionDataA

12、ccessed:/globalvariablesordatabasetablestobevisitedDataUpdated:/globalvariablesordatabasetablestobemodifiedInput:/descriptionofeachinputparameter,/includingfunctiondescription、valuedescription,/andrelationshipsoftheparametersOutput:/descriptionofoutputparameterReturn:/descriptionofreturnvalueOthers:

13、/otherdescriptionsImplement:pseudocodeorflowchartcanbeusedhere用以下格式描述函数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申请消息包失败返回M