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

1、產(chǎn)品名稱密級產(chǎn)品版本共8頁XX詳細(xì)設(shè)計(jì)說明書擬制日期yyyy-mm-dd評審人日期yyyy-mm-dd批準(zhǔn)日期yyyy-mm-dd公司或企業(yè)圖標(biāo)公司或企業(yè)中英文名稱所有侵權(quán)必究僅供部使用修訂記錄日期修訂版本Defec t IDCR號修改早下修改描述作者2001-06081.00初稿完成作者名yyyy-mm- dd1.01xxxx.x.x;y.y.y修改XXXXxxXxx.作者名xxxx.x.x;y.y.y修改XXXXxxXxx.yyyy-mm- dd1.02xxxx.x.x;y.y.y修改XXXXxxXxx.作者名+-yyyy-mm- dd2.00 xxxx.x.x;y.y.y修改XXXXxx

2、Xxx.作者名分發(fā)記錄Copy No.持啟后和角色分發(fā)日期1yyyy-mm-dd2Project Manager工程經(jīng)理 yyyy-mm-dd3yyyy-mm-dd4Customer Representative客戶代表yyyy-mm-dd5Others 其它 yyyy-mm-dd目錄1簡介4目的4圍42詳細(xì)設(shè)計(jì)4模塊1詳細(xì)設(shè)計(jì)4數(shù)據(jù)描述5.簡單數(shù)據(jù)描述；5 TOC o 1-5 h z .構(gòu)造1 5.構(gòu)造25函數(shù)描述5.函數(shù)1 6.函數(shù)27模塊2詳細(xì)設(shè)計(jì)7錯(cuò)誤處理7系統(tǒng)錯(cuò)誤7接口錯(cuò)誤8協(xié)議錯(cuò)誤8表目錄Table1*表錯(cuò)誤！未定義書簽。表1*表錯(cuò)誤！未定義書簽。Figure IModule 1

3、Structure Chart圖目錄模塊1構(gòu)造圖6XX詳細(xì)設(shè)計(jì)說明書關(guān)鍵詞:摘要：縮略語清單： 對本文所用縮略語進(jìn)展說明，要求提供每個(gè)縮略語的英文全名和中文解釋?？s略語英文全名中文解釋簡介目的描述本文的目的，一般詳細(xì)設(shè)計(jì)必須能夠直接指導(dǎo)編碼活動(dòng)。圍本節(jié)應(yīng)描述文檔所包括和不包括的容。詳細(xì)設(shè)計(jì)對于在概要設(shè)計(jì)說明書中給出的軟件實(shí)體，本節(jié)集中描述它們的詳細(xì)描述局部。模塊1詳細(xì)設(shè)計(jì)描述模塊中定義和使用的數(shù)據(jù)，包括：簡單數(shù)據(jù)，如模塊級的全局變量、常量、宏;復(fù)合數(shù)據(jù)，如模塊部的構(gòu)造、聯(lián)合數(shù)據(jù)描述在2.1.1.1中描述本模塊中的簡單變量、常量、宏；從2.1.1.2起描述本模塊中的復(fù)合數(shù)據(jù)，如構(gòu)造、聯(lián)合等;.簡

4、單數(shù)據(jù)描述；描述在本模塊中定義和使用的簡單變量、常量、宏；按照以下格式進(jìn)展簡單數(shù)據(jù)的描述功能描述：描述該數(shù)據(jù)的用途數(shù)據(jù)定義：定義該數(shù)據(jù).構(gòu)造1定義和說明該數(shù)據(jù)構(gòu)造（包括聯(lián)合）；按照以下格式進(jìn)展數(shù)據(jù)構(gòu)造的描述數(shù)據(jù)構(gòu)造描述：描述該數(shù)據(jù)構(gòu)造的用途數(shù)據(jù)構(gòu)造定義：用實(shí)際的編程語言定義該數(shù)據(jù)構(gòu)造函數(shù)描述本節(jié)應(yīng)按照以下格式進(jìn)展描述:標(biāo)識：模塊名稱類型：模塊類型，如，2級設(shè)計(jì)中白模塊，1級設(shè)計(jì)中的進(jìn)程功能概述：簡要描述本模塊功能，要和概要設(shè)計(jì)文檔中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系：用層次圖或構(gòu)造圖的方式描述函數(shù)調(diào)用關(guān)系，如：FunctionlFunction2Function3Figure 1 Modul

5、e 1 Structure Chart模塊 1 構(gòu)造圖.函數(shù)1用以下格式描述函數(shù)Function:/函數(shù)名稱Description: /函數(shù)功能、性能等的描述Calls:/被本函數(shù)調(diào)用的函數(shù)清單Data Accessed: /被訪問的全局變量和數(shù)據(jù)庫表Data Updated: /被修改的全局變量和數(shù)據(jù)庫表Input:/輸入?yún)?shù)說明，包括每個(gè)參數(shù)的作用、取值說明及參數(shù)間關(guān)系Output:/對輸出參數(shù)的說明Return:/函數(shù)返回值的說明Others:/其它說明實(shí)現(xiàn)：這里可以使用偽碼或流程圖例子 :m2ua_return_t m2ua_nif_sendto_mtp2/* 該函數(shù)重用原來MTP3

6、模塊中提供的向 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 ，失敗填寫目的功能模

7、塊號到 pMsg填上消息包的具體容調(diào)用消息發(fā)送函數(shù)VOS_SendMsg , VOS把消息包發(fā)送到給MTP2返回 M2UA_SUCCESS ，成功. 函數(shù) 2模塊2詳細(xì)設(shè)計(jì)錯(cuò)誤處理描述象存分配失敗，任務(wù)創(chuàng)立失敗等錯(cuò)誤是如何被處理的。接口錯(cuò)誤描述將要產(chǎn)生并給外部實(shí)體用的錯(cuò)誤碼協(xié)議錯(cuò)誤描述在協(xié)議中沒有描述的情況如何處理?？蛇x參考資料清單：請羅列本文檔所參考的有關(guān)參考文獻(xiàn)和相關(guān)文檔，格式如下：作者書名或雜志、文獻(xiàn)、文檔或期號、卷號、公司文檔編號出版日期頁碼例如：D. B. Leeson,“A Simple Model of Feedback Oscillator Noise Spectrum,pp329-330, February 1966 英文文章格式D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991書籍格式3王陽元，奚雪梅等， 薄膜SOI/CMOS SPICE電路