某軟件詳細(xì)設(shè)計模板_第1頁
某軟件詳細(xì)設(shè)計模板_第2頁
某軟件詳細(xì)設(shè)計模板_第3頁
某軟件詳細(xì)設(shè)計模板_第4頁
某軟件詳細(xì)設(shè)計模板_第5頁
已閱讀5頁,還剩7頁未讀, 繼續(xù)免費閱讀

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認(rèn)領(lǐng)

文檔簡介

產(chǎn)品名稱Productname密級Confidentialitylevel產(chǎn)品版本ProductversionTotalNUMXXLowLevelDesignSpecification

XX詳細(xì)設(shè)計說明書Keywords關(guān)鍵詞:Abstract摘要:Listofabbreviations縮略語清單:<對本文所用縮略語進行說明,要求提供每個縮略語的英文全名和中文解釋。Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.>Abbreviations縮略語Fullspelling英文全名Chineseexplanation中文解釋

Introduction簡介Purpose目的Todescriptthepurposeofthisdocument.Ingeneral,LLDspecificationcanbeusedtoguidethecodingactivitiesdirectly.描述本文的目的,一般詳細(xì)設(shè)計必須能夠直接指導(dǎo)編碼活動。Scope范圍Thissectionshouldaddressareaswhichthisdocumentincludesandthatarespecificallyexcludes.本節(jié)應(yīng)描述文檔所包括和不包括的內(nèi)容。DetailedDesign詳細(xì)設(shè)計ThissectionshouldfocusonthedescriptionofthedetaileddesignofthesoftwareentitiesthatareapartofthesoftwarebeingdescribedbytheHLDSpecification。.對于在概要設(shè)計說明書中給出的軟件實體,本節(jié)集中描述它們的詳細(xì)描述部分。Module1DetailDesign模塊1詳細(xì)設(shè)計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按照下列格式進行簡單數(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:DataTypeDataItemDefinitionDataItemDescription按照下列格式進行數(shù)據(jù)結(jié)構(gòu)的描述數(shù)據(jù)結(jié)構(gòu)描述:描述該數(shù)據(jù)結(jié)構(gòu)的用途數(shù)據(jù)結(jié)構(gòu)定義:用實際的編程語言定義該數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)項描述:數(shù)據(jù)類型數(shù)據(jù)項定義數(shù)據(jù)項描述Structure2結(jié)構(gòu)2

FunctionDescription函數(shù)描述Thissectionshouldfollowtheformatbelow:Identification:TitleofthemoduleType:Typeofthemodule,forexample,themoduleinLevel2Design,theprocessinLevel1Design,etc.FunctionDescription:Describingthefunctionsofthemoduleinbrief,whichshouldbeconsistentwiththerelatedsectioninHLDdocuments.FunctionInvokingRelation:UsingtheHierarchyChartorStructureCharttodescribeit,forexample:本節(jié)應(yīng)按照下列格式進行描述:標(biāo)識:模塊名稱類型:模塊類型,如,2級設(shè)計中的模塊,1級設(shè)計中的進程功能概述:簡要描述本模塊功能,要和概要設(shè)計文檔中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系:用層次圖或結(jié)構(gòu)圖的方式描述函數(shù)調(diào)用關(guān)系,如:Module1StructureChart模塊1結(jié)構(gòu)圖Function1函數(shù)1Descriptthefunctionasfollows;Function://nameoffunctionDescription://functionalityofthefunctionCalls://functionlistswhichcalledbythisfunctionDataAccessed://globalvariablesordatabasetablestobevisitedDataUpdated://globalvariablesordatabasetablestobemodifiedInput://descriptionofeachinputparameter,//includingfunctiondescription、valuedescription,//andrelationshipsoftheparametersOutput://descriptionofoutputparameterReturn://descriptionofreturnvalueOthers://otherdescriptionsImplement:pseudocodeorflowchartcanbeusedhere用以下格式描述函數(shù)Function://函數(shù)名稱Description://函數(shù)功能、性能等的描述Calls://被本函數(shù)調(diào)用的函數(shù)清單DataAccessed://被訪問的全局變量和數(shù)據(jù)庫表DataUpdated://被修改的全局變量和數(shù)據(jù)庫表Input://輸入?yún)?shù)說明,包括每個參數(shù)的作用、取值說明及參數(shù)間關(guān)系。Output://對輸出參數(shù)的說明。Return://函數(shù)返回值的說明Others://其它說明實現(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,為臨時變量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ù)2

Module2DatailDesign模塊2詳細(xì)設(shè)計ErrorProcess錯誤處理SystemError系統(tǒng)錯誤Describeshowtheerrors,suchasmemoryallocationfailure,taskcreationfailure,tobeprocessed.描述象內(nèi)存分配失敗,任務(wù)創(chuàng)建失敗等錯誤是如何被處理的。InterfaceError接口錯誤Describestheerrorcodestobegeneratedfortheexternalentities.描述將要產(chǎn)生并給外部實體用的錯誤碼ProtocolError協(xié)議錯誤Describeshowtohandletheerrorsnotmentionedintheprotocols.(Optional)描述在協(xié)議中沒有描述的情況如何處理。(可選)

Listofreference參考資料清單:Pleaselistreferredliteratureandrelateddocuments,format:請羅列本文檔所參考的有關(guān)參考文獻和相關(guān)文檔,格式如下:Author+bookname(ormagazine,literature,document)+publishingcompany(orissueNo.,volumeNo.,internaldocumentationID)+publishingdate+startandendpagenumber,作者+書名(或雜志、文獻、文檔)+出版社(或期號、卷號、公司文檔編號)+出版日期+起止頁碼examples:例如:D.B.Leeson,“ASimpleModelofFeedbackOscillatorNoiseSpec

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

最新文檔

評論

0/150

提交評論