華為軟件詳細(xì)設(shè)計(jì)模板

產(chǎn)品名稱Productname密級Confidentialitylevel產(chǎn)品版本ProductversionTotal14pages共14頁XXLowLevelDesignSpecificationXX詳細(xì)設(shè)計(jì)說明書Preparedby擬制Name+ID姓名+工號Date日期yyyy-mm-ddReviewedbyDateyyyy-mm-dd評審人日期ApprovedbyDateyyyy-mm-dd批準(zhǔn)日期..專業(yè).專注...word可編輯XXXXCo.,Ltd.XXXX有限公司..專業(yè).專注..word.word可編輯RevisionRecord修訂記錄Date日期RevisionVersion修訂版本CRID/DefectIDCR號SecNo.修改早下ChangeDescription修改描述Author作者1.1...專業(yè).專注...word可編輯Catalog目錄Introduction簡介7.Purpose目的7Scope范圍7DetailedDesign詳細(xì)設(shè)計(jì)7Module1DetailDesign模塊1詳細(xì)設(shè)計(jì)7DataDescription數(shù)據(jù)描述7FunctionDescription函數(shù)描述1...0Module2DatailDesign模塊2詳細(xì)設(shè)計(jì)1..3ErrorProcess錯(cuò)誤處理1..3SystemError系統(tǒng)錯(cuò)誤1...3InterfaceError接口錯(cuò)誤1..3ProtocolError協(xié)議錯(cuò)誤1..3TableList目錄Table1**表錯(cuò)誤!.未定義書簽。表1**表錯(cuò)誤!.未定義書簽。FigureList圖目錄Figure1Module1StructureChart模塊1結(jié)構(gòu)圖1...0...專業(yè).專注..word.word可編輯XXLowLevelDesignSpecificationXX詳細(xì)設(shè)計(jì)說明書Keywords關(guān)鍵詞：Abstract摘要：Listofabbreviations縮略語清單：<對本文所用縮略語進(jìn)行說明，要求提供每個(gè)縮略語的英文全名和中文解釋。Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.〉A(chǔ)bbreviations縮略語Fullspelling央義全名Chineseexplanation中文解釋..專業(yè).專注...word可編輯Introduction簡介Purpose目的Todescriptthepurposeofthisdocument.Ingeneral,LLDspecificationcanbeusedtoguidethecodingactivitiesdirectly.描述本文的目的，一般詳細(xì)設(shè)計(jì)必須能夠直接指導(dǎo)編碼活動(dòng)。Scope范圍Thissectionshouldaddressareaswhichthisdocumentincludesandthatarespecificallyexcludes.本節(jié)應(yīng)描述文檔所包括和不包括的內(nèi)容。DetailedDesign詳細(xì)設(shè)計(jì)ThissectionshouldfocusonthedescriptionofthedetaileddesignofthesoftwareentitiesthatareapartofthesoftwarebeingdescribedbytheHLDSpecification。.對于在概要設(shè)計(jì)說明書中給出的軟件實(shí)體，本節(jié)集中描述它們的詳細(xì)描述部分。Module1DetailDesign模塊1詳細(xì)設(shè)計(jì)Describedatathatdefinedorusedinthemodule,including:simpledatai.e.globalvariable,constantormacrowithinthemodule;complexdatai.e.Structureorunion描述模塊中定義和使用的數(shù)據(jù)，包括：簡單數(shù)據(jù)，如模塊級的全局變量、常量、宏；復(fù)合數(shù)據(jù)，如模塊內(nèi)部的結(jié)構(gòu)、聯(lián)合...；DataDescription數(shù)據(jù)描述Describesimplevariables,constantormacroofthemoduleinsection2.1.1.1;Describecomplexdatafromsection2.1.1.2,suchasstructure,union;在2.1.1.1中描述本模塊中的簡單變量、常量、宏；從2.1.1.2起描述本模塊中的復(fù)合數(shù)據(jù)，如結(jié)構(gòu)、聯(lián)合等；SimpleDataDescription簡單數(shù)據(jù)描述describesimplevariables、constantormacrousedordefinedinthismodule;描述在本模塊中定義和使用的簡單變量、常量、宏；Describessimplevariables,constantsusedordefinedinthismodule;Thedescriptionofsimpledatashouldfollowtheformatbelow:FunctionDescription:DescribingtheusageofthedataDataDefinition:Definingthedata按照下列格式進(jìn)行簡單數(shù)據(jù)的描述功能描述：描述該數(shù)據(jù)的用途數(shù)據(jù)定義：定義該數(shù)據(jù)Structure1結(jié)構(gòu)1DefineanddescribetheDatastructure(includeunion)定義和說明該數(shù)據(jù)結(jié)構(gòu)(包括聯(lián)合);Thedescriptionofdatastructureshouldfollowtheformatbelow:DataStructureDescription:DescribingtheusageofthedatastructureDataStructureDefinition:DefiningthedatastructurewiththeactualprograminglanguageDataItemsDescription:..專業(yè).專注..word.word可編輯DataTypeDataItemDefinitionDataItemDescription按照下列格式進(jìn)行數(shù)據(jù)結(jié)構(gòu)的描述數(shù)據(jù)結(jié)構(gòu)描述：描述該數(shù)據(jù)結(jié)構(gòu)的用途數(shù)據(jù)結(jié)構(gòu)定義：用實(shí)際的編程語言定義該數(shù)據(jù)結(jié)構(gòu)FunctionDescription函數(shù)描述Thissectionshouldfollowtheformatbelow:Identification:TitleofthemoduleType:Typeofthemodule,forexample,themoduleinLevel2Design,theprocessinLevel1Design,etc.FunctionDescription:Describingthefunctionsofthemoduleinbrief,whichshouldbeconsistentwiththerelatedsectioninHLDdocuments.FunctionInvokingRelation:UsingtheHierarchyChartorStructureCharttodescribeit,forexample:本節(jié)應(yīng)按照下列格式進(jìn)行描述：標(biāo)識(shí)：模塊名稱類型：模塊類型，如，2級設(shè)計(jì)中的模塊，1級設(shè)計(jì)中的進(jìn)程功能概述：簡要描述本模塊功能，要和概要設(shè)計(jì)文檔中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系：用層次圖或結(jié)構(gòu)圖的方式描述函數(shù)調(diào)用關(guān)系，如：Figure1Module1StructureChart模塊1結(jié)構(gòu)圖Function1函數(shù)1Descriptthefunctionasfollows;Function://nameoffunctionDescription://functionalityofthefunction..專業(yè).專注...word可編輯Calls://functionlistswhichcalledbythisfunctionDataAccessed://globalvariablesordatabasetablestobevisitedDataUpdated://globalvariablesordatabasetablestobemodifiedInput://descriptionofeachinputparameter,//includingfunctiondescription、valuedescription，Output:Return:Others://andrelationshipsoftheparameters//descriptionofoutputparameter//descriptionofreturnvalue//otherdescriptionsImplement:pseudocodeorflowchartcanbeusedhereImplement:用以下格式描述函數(shù)Function://函數(shù)名稱Description://函數(shù)功能、性能等的描述Calls://被本函數(shù)調(diào)用的函數(shù)清單DataAccessed://被訪問的全局變量和數(shù)據(jù)庫表DataUpdated://被修改的全局變量和數(shù)據(jù)庫表Input://輸入?yún)?shù)說明，包括每個(gè)參數(shù)的作用、取值說明及參數(shù)間關(guān)系。Output://對輸出參數(shù)的說明。Return://函數(shù)返回值的說明Others://其它說明這里可以使用偽碼或流程圖實(shí)現(xiàn)：這里可以使用偽碼或流程圖例子:m2ua_return_tm2ua_nif_sendto_mtp2/*該函數(shù)重用原來MTP3模塊中提供的向MTP2發(fā)消息的函數(shù)*/if鏈路號不合法返回M2UA_FAILURE，失敗if消息類型不正確返回M2UA_FAILURE，失敗if參數(shù)指針為空返回M2UA_FAILURE，失敗調(diào)用消息申請函數(shù)VOS_AllocMsg，為臨時(shí)變量pMsg申請消息包空間if申請消息包失敗返回M2UA_FAILURE，消息申請函數(shù)填寫發(fā)送模塊信息到pMsg調(diào)用設(shè)備管理的函數(shù)Dev_FromVspCardNoGetCpuid，填寫目的板的CPUIDif調(diào)用失敗調(diào)用VOS_FreeMsg，釋放pMsg的消息包空間返回M2UA_FAILURE，失敗填寫目的功能模塊號到pMsg填上消息包的具體內(nèi)容調(diào)用消息發(fā)送函數(shù)VOS_SendMsg,VOS把消息包發(fā)送到給MTP2返回M2UA_SUCCESS，成功Function2函數(shù)2Module2DatailDesign模塊2詳細(xì)設(shè)計(jì)ErrorProcess錯(cuò)誤處理SystemError系統(tǒng)錯(cuò)誤Describeshowtheerrors,suchasmemoryallocationfailure,taskcreationfailure,tobeprocessed.描述象內(nèi)存分配失敗，任務(wù)創(chuàng)建失敗等錯(cuò)誤是如何被處理的。InterfaceError接口錯(cuò)誤Describestheerrorcodestobegeneratedfortheexternalentities.描述將要產(chǎn)生并給外部實(shí)體用的錯(cuò)誤碼ProtocolError協(xié)議錯(cuò)誤Describeshowtohandletheerrorsnotmentionedintheprotocols.(Optional)描述在協(xié)議中沒有描述的情況如何處理。(可選)Listofreference參考資料清單：Pleaselistreferredliteratureandrelateddocuments,format:請羅列本文檔所參考的有關(guān)參考文獻(xiàn)和相關(guān)文檔，格式如下：Author+bookname（ormagazine,literature,document）+publishingcompany（orissueNo.,volumeNo.,internaldocumentationID）+publishingdate+startandendpagenumber,作者＋書名（或雜志、文獻(xiàn)、文檔）＋出版社（或期號、卷號、公司文檔編號）＋出版日期+起止頁碼examples:例如：D.B.Leeson,“ASimpleModelofFeedbackOscill