LLD詳細(xì)設(shè)計(jì)說(shuō)明書(shū)模板

.產(chǎn)品名稱(chēng) 密級(jí)產(chǎn)品版本共11頁(yè)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)擬制日期yyyy-mm-dd評(píng)審人日期yyyy-mm-dd批準(zhǔn)日期yyyy-mm-dd公司或企業(yè)圖標(biāo)>公司或企業(yè)中英文名稱(chēng)>版權(quán)所有 侵權(quán)必究（僅供內(nèi)部使用）Word資料公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)修訂記錄日期修訂Defect修改修改描述作者版本ID章節(jié)CR號(hào)2001-06-1.00初稿完成作者名08yyyy-mm-1.01xxxx.x.x;修改XXX作者名ddy.y.y1.Xxx2.Xxx3....xxxx.x.x;修改XXXy.y.y1.Xxx2.Xxx3....yyyy-mm-1.02xxxx.x.x;修改XXX作者名ddy.y.y1.Xxx2.Xxx3....+-yyyy-mm-2.00xxxx.x.x;修改XXX作者名ddy.y.y1.Xxx2.Xxx3....分發(fā)記錄Copy持有者和角色分發(fā)日期No.1<RDPDTPDT開(kāi)發(fā)代表>yyyy-mm-dd2<ProjectManager項(xiàng)目經(jīng)理>yyyy-mm-dd3<Teammembers項(xiàng)目組成員>yyyy-mm-dd4<CustomerRepresentative客戶(hù)代表>yyyy-mm-dd5<Others其它>yyyy-mm-dd版權(quán)所有，侵權(quán)必究 第2頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)目錄1簡(jiǎn)介....................................................................................................................................................................................61.1目的...............................................................................................................................................................................61.2范圍...............................................................................................................................................................................62詳細(xì)設(shè)計(jì)...........................................................................................................................................................................62.1模塊1詳細(xì)設(shè)計(jì)..........................................................................................................................................................62.1.1數(shù)據(jù)描述..............................................................................................................................................................61.簡(jiǎn)單數(shù)據(jù)描述；.........................................................................................................................................62.結(jié)構(gòu)1.............................................................................................................................................................63.結(jié)構(gòu)2.............................................................................................................................................................72.1.2函數(shù)描述..............................................................................................................................................................81.函數(shù)1.............................................................................................................................................................82.函數(shù)2.............................................................................................................................................................92.2模塊2詳細(xì)設(shè)計(jì)........................................................................................................................................................102.310101010版權(quán)所有，侵權(quán)必究 第3頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)表目錄Table1 **表.............................................................................................................................錯(cuò)誤!未定義書(shū)簽。表1 **表....................................................................................................................................錯(cuò)誤!未定義書(shū)簽。圖目錄Figure1 Module1StructureChart 模塊1結(jié)構(gòu)圖 8版權(quán)所有，侵權(quán)必究 第4頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)關(guān)鍵詞：摘 要：縮略語(yǔ)清單：<對(duì)本文所用縮略語(yǔ)進(jìn)行說(shuō)明，要求提供每個(gè)縮略語(yǔ)的英文全名和中文解釋。縮略語(yǔ) 英文全名 中文解釋版權(quán)所有，侵權(quán)必究 第5頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)簡(jiǎn)介1.1 目的描述本文的目的，一般詳細(xì)設(shè)計(jì)必須能夠直接指導(dǎo)編碼活動(dòng)。1.2 范圍本節(jié)應(yīng)描述文檔所包括和不包括的內(nèi)容。詳細(xì)設(shè)計(jì)對(duì)于在概要設(shè)計(jì)說(shuō)明書(shū)中給出的軟件實(shí)體，本節(jié)集中描述它們的詳細(xì)描述部分。2.1 模塊1詳細(xì)設(shè)計(jì)描述模塊中定義和使用的數(shù)據(jù)，包括：簡(jiǎn)單數(shù)據(jù)，如模塊級(jí)的全局變量、常量、宏；復(fù)合數(shù)據(jù)，如模塊內(nèi)部的結(jié)構(gòu)、聯(lián)合 ...； 數(shù)據(jù)描述在中描述本模塊中的簡(jiǎn)單變量、常量、宏；從起描述本模塊中的復(fù)合數(shù)據(jù)，如結(jié)構(gòu)、聯(lián)合等；簡(jiǎn)單數(shù)據(jù)描述；描述在本模塊中定義和使用的簡(jiǎn)單變量、常量、宏；按照下列格式進(jìn)行簡(jiǎn)單數(shù)據(jù)的描述功能描述：描述該數(shù)據(jù)的用途數(shù)據(jù)定義：定義該數(shù)據(jù)結(jié)構(gòu)1定義和說(shuō)明該數(shù)據(jù)結(jié)構(gòu)(包括聯(lián)合);按照下列格式進(jìn)行數(shù)據(jù)結(jié)構(gòu)的描述數(shù)據(jù)結(jié)構(gòu)描述：描述該數(shù)據(jù)結(jié)構(gòu)的用途版權(quán)所有，侵權(quán)必究 第6頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)數(shù)據(jù)結(jié)構(gòu)定義：用實(shí)際的編程語(yǔ)言定義該數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)項(xiàng)描述：數(shù)據(jù)類(lèi)型 數(shù)據(jù)項(xiàng)定義 數(shù)據(jù)項(xiàng)描述結(jié)構(gòu)2版權(quán)所有，侵權(quán)必究 第7頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí) 函數(shù)描述本節(jié)應(yīng)按照下列格式進(jìn)行描述：標(biāo)識(shí)：模塊名稱(chēng)類(lèi)型：模塊類(lèi)型，如，2級(jí)設(shè)計(jì)中的模塊，1級(jí)設(shè)計(jì)中的進(jìn)程功能概述：簡(jiǎn)要描述本模塊功能，要和概要設(shè)計(jì)文檔中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系:用層次圖或結(jié)構(gòu)圖的方式描述函數(shù)調(diào)用關(guān)系，如：Function1A,BD,ECFunction2 Function3Figure1 Module1StructureChart 模塊1結(jié)構(gòu)圖函數(shù)1用以下格式描述函數(shù)Function: //函數(shù)名稱(chēng)Description: //函數(shù)功能、性能等的描述Calls: //被本函數(shù)調(diào)用的函數(shù)清單DataAccessed://被訪問(wèn)的全局變量和數(shù)據(jù)庫(kù)表DataUpdated://被修改的全局變量和數(shù)據(jù)庫(kù)表Input: //輸入?yún)?shù)說(shuō)明，包括每個(gè)參數(shù)的作用、取值說(shuō)明及參數(shù)間關(guān)系。Output: // 對(duì)輸出參數(shù)的說(shuō)明。Return: //函數(shù)返回值的說(shuō)明Others: //其它說(shuō)明----------------------------------------------------------------------------------------------------實(shí)現(xiàn)： 這里可以使用偽碼或流程圖例子:版權(quán)所有，侵權(quán)必究 第8頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)m2ua_return_tm2ua_nif_sendto_mtp2/*該函數(shù)重用原來(lái)MTP3模塊中提供的向MTP2發(fā)消息的函數(shù)*/if鏈路號(hào)不合法返回M2UA_FAILURE，失敗if消息類(lèi)型不正確返回M2UA_FAILURE，失敗if參數(shù)指針為空返回M2UA_FAILURE，失敗調(diào)用消息申請(qǐng)函數(shù)VOS_AllocMsg，為臨時(shí)變量pMsg申請(qǐng)消息包空間if申請(qǐng)消息包失敗返回M2UA_FAILURE，消息申請(qǐng)函數(shù)填寫(xiě)發(fā)送模塊信息到pMsg調(diào)用設(shè)備管理的函數(shù)Dev_FromVspCardNoGetCpuid，填寫(xiě)目的板的CPUIDif調(diào)用失敗調(diào)用VOS_FreeMsg，釋放pMsg的消息包空間返回M2UA_FAILURE，失敗填寫(xiě)目的功能模塊號(hào)到pMsg填上消息包的具體內(nèi)容調(diào)用消息發(fā)送函數(shù)VOS_SendMsg，VOS把消息包發(fā)送到給MTP2返回M2UA_SUCCESS，成功函數(shù)2版權(quán)所有，侵權(quán)必究 第9頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)2.2 模塊2詳細(xì)設(shè)計(jì)2.3 錯(cuò)誤處理 系統(tǒng)錯(cuò)誤描述象內(nèi)存分配失敗，任務(wù)創(chuàng)建失敗等錯(cuò)誤是如何被處理的。 接口錯(cuò)誤描述將要產(chǎn)生并給外部實(shí)體用的錯(cuò)誤碼 協(xié)議錯(cuò)誤描述在協(xié)議中沒(méi)有描述的情況如何處理。（可選）版權(quán)所有，侵權(quán)必究 第10頁(yè)，共11頁(yè)公司或企業(yè)圖標(biāo)XX詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 請(qǐng)輸入密級(jí)參考資料清單：請(qǐng)羅列本文檔所參考的有關(guān)參考文獻(xiàn)和相關(guān)文檔，格式如下：作者＋書(shū)名（或雜志、文獻(xiàn)、文檔）＋出版社（或期號(hào)、卷號(hào)、公司文檔編號(hào)）＋出版日期 +起止頁(yè)碼例如：D.B.Leeson,“ASimpleModelofFeedbackOscillatorNoiseSpectrum,”P(pán)roc.IEEE,pp329-3