軟件詳細(xì)設(shè)計(jì)說(shuō)明書

1、文檔編號(hào)廣品版本密級(jí)產(chǎn)品名稱：共 頁(yè)XX模塊軟件詳細(xì)設(shè)計(jì)說(shuō)明書（僅供內(nèi)部使用）擬制：日期：yyyy-mm-dd審核：日期：yyyy-mm-dd核準(zhǔn)：日期：yyyy-mm-dd日期：yyyy-mm-dd文檔版本：版權(quán)所有 侵權(quán)必究文件修改記錄修改日期版本修改頁(yè)他、章節(jié)、條 款修改描述作者yyyy-mm-dd1目的 錯(cuò)誤!未指定書簽。2代碼框架描述 錯(cuò)誤!未指定書簽o2.1 目錄結(jié)構(gòu) 錯(cuò)誤!未指定書簽。2.2 源文件說(shuō)明 錯(cuò)誤!未指定書簽。2.3 模塊配置文件說(shuō)明 錯(cuò)誤!未指定書簽。3數(shù)據(jù)2構(gòu) 錯(cuò)誤!未指定書簽。3.1 數(shù)據(jù)結(jié)本勾定義錯(cuò)誤!未指定書簽。3.2 數(shù)據(jù)結(jié)構(gòu)關(guān)系圖（可選） 錯(cuò)誤!未指定書

2、簽。3.3 公共頭文件定義錯(cuò)誤!未指定書簽。4子模塊（實(shí)體）1詳細(xì)設(shè)計(jì)說(shuō)明 錯(cuò)誤!未指定書簽。4.1 數(shù)據(jù)Z構(gòu) 錯(cuò)誤!未指定書簽。4.2 處理流程詳細(xì)說(shuō)明 錯(cuò)誤!未指定書簽。4.3 編碼設(shè)計(jì)錯(cuò)誤!未指定書簽。4.3.1 函數(shù)1 錯(cuò)誤!未指定書簽。4.3.2 函數(shù)2 錯(cuò)誤!未指定書簽。43n函數(shù)n 錯(cuò)誤!未指定書簽。5子模塊（實(shí)體）2詳細(xì)設(shè)計(jì)說(shuō)明 錯(cuò)誤!未指定書簽。6附錄 子系統(tǒng)定義表 錯(cuò)誤!未指定書簽。軟件詳細(xì)設(shè)計(jì)說(shuō)明書關(guān)鍵詞：摘要：縮略語(yǔ)說(shuō)明:縮略語(yǔ)英文全名中文解釋參考資料：列出本文檔的所有參考文獻(xiàn)（包括：正式/非正式出版物、公司/部門文檔等），格式如下: 作者+書名（或雜志、文獻(xiàn)、文檔）+

3、出版社（或期號(hào)、卷號(hào)、公司文檔編號(hào)）+出版日期 模板使用說(shuō)明：1注明可選的部分，可以根據(jù)實(shí)際情況選擇是否填寫；如果不必說(shuō)明，請(qǐng)務(wù)必保留相 關(guān)的章節(jié)標(biāo)題，同時(shí)在該可選章節(jié)的內(nèi)容中填入“無(wú)”；未注名可選的，則必須描述；如果 有些設(shè)計(jì)此模版中沒(méi)有合適的地方填寫，則補(bǔ)充在最后的其他欄目中2模版中斜體字相當(dāng)于撰寫指南，最后文稿請(qǐng)將本模板中所有的斜體字部分全部刪除。3模板里并不說(shuō)明設(shè)計(jì)技術(shù)和方法，而只是說(shuō)明應(yīng)包含哪些內(nèi)容，以及如何描述、組 織這些內(nèi)容。4對(duì)于移植的代碼，描述可以相對(duì)簡(jiǎn)單一些，但以下這些章節(jié)不能省略：代碼框架描述、第3節(jié)可以簡(jiǎn)寫，第4節(jié)可以根據(jù)項(xiàng)目實(shí)際情況簡(jiǎn)寫1目的闡明編寫詳細(xì)設(shè)計(jì)說(shuō)明書的目

4、的2代碼框架描述本部分描述系統(tǒng)的源代碼分布框架，說(shuō)明源代碼存放的目錄結(jié)構(gòu)、各源文件的功能。 總體設(shè)計(jì)中有一個(gè)開(kāi)發(fā)視圖，這一部分就是對(duì)總體設(shè)計(jì)中開(kāi)發(fā)視圖的進(jìn)一步細(xì)化。2.1 目錄結(jié)構(gòu)說(shuō)明系統(tǒng)源代碼文件存放的目錄、子目錄，及其包含的文件列表。如下：目錄名稱目錄說(shuō)明包含源文件列表2.2 源文件說(shuō)明如下表格式對(duì)系統(tǒng)包含的源代碼文件進(jìn)行大致說(shuō)明:源文件名稱文件描述子模塊1文件1文件n子模塊2文件1文件n注：“目錄結(jié)構(gòu)”和“源文件說(shuō)明”表格在詳細(xì)設(shè)計(jì)后期和編碼階段都可能被修改2.3 模塊配置文件說(shuō)明該模塊在配置文件中的實(shí)現(xiàn)腳本代碼。3 數(shù)據(jù)結(jié)構(gòu)3.1 數(shù)據(jù)結(jié)構(gòu)定義實(shí)現(xiàn)該模塊的主要數(shù)據(jù)結(jié)構(gòu)定義?？梢允褂肅

5、語(yǔ)言描述數(shù)據(jù)結(jié)構(gòu)定義，對(duì)于每個(gè)成員變量必須進(jìn)行說(shuō)明。如果涉及到配置描述，也請(qǐng)?jiān)谶@里說(shuō)明。因?yàn)橛械暮甓x可能是通過(guò)makeconfig 文件生成的，所以這里需要描述涉及到哪些宏。3.2 數(shù)據(jù)結(jié)構(gòu)關(guān)系圖（可選）畫出模塊內(nèi)部數(shù)據(jù)結(jié)構(gòu)之間以及和外部基礎(chǔ)結(jié)構(gòu)之間的關(guān)系圖，并文字描述其關(guān)系。數(shù)據(jù)結(jié)構(gòu)之間的關(guān)聯(lián)關(guān)系對(duì)應(yīng)關(guān)系是如何的。如果圖中還不足以描述清楚的部分，必須附加文字說(shuō)明3.3 公共頭文件定義將所有開(kāi)放給外部模塊可以訪問(wèn)的數(shù)據(jù)結(jié)構(gòu)和函數(shù)定義保存在公共頭文件中，這個(gè)公共頭文件在include 下的特定目錄中。需要羅列出公共頭文件名，保存路徑，以及公共頭文件的內(nèi)容。比如 : Xxx.h （ 路徑： in

6、clude/net/xxx）如果在 include 下有多個(gè)頭文件，那么必須制定一個(gè)主文件，也就是說(shuō)，只要include了這個(gè)主文件，就可以得到這個(gè)模塊對(duì)外提供的所有服務(wù)功能的聲明了。4 子模塊（實(shí)體）1 詳細(xì)設(shè)計(jì)說(shuō)明主要從數(shù)據(jù)結(jié)構(gòu)和函數(shù)（算法）兩個(gè)方面進(jìn)行詳細(xì)設(shè)計(jì)說(shuō)明。對(duì)于詳細(xì)設(shè)計(jì)，如果你覺(jué)得還有一些要素的描述可以幫助理解本設(shè)計(jì)文檔，則可以增加一個(gè)或多個(gè)小節(jié)進(jìn)行描述，這個(gè)由設(shè)計(jì)人員自行把握，不做強(qiáng)制約定。注：因?yàn)樵敿?xì)設(shè)計(jì)的目的是為了編碼，所以其設(shè)計(jì)輸出應(yīng)當(dāng)盡可能地使后面的編碼工作變得方便快捷，同時(shí)達(dá)到設(shè)計(jì)目標(biāo)要求?？梢哉f(shuō)， 前面的總體設(shè)計(jì)工作主要在于闡述設(shè)計(jì)思想，目的是為了使項(xiàng)目的審核者、維

7、護(hù)者、編碼者更好地理解設(shè)計(jì)原理，也為了他們?cè)诒匾臅r(shí)候更好地理解代碼。而詳細(xì)設(shè)計(jì)則詳細(xì)具體地描述了設(shè)計(jì)目標(biāo)的實(shí)現(xiàn)方法和步驟。所以，本節(jié)是編碼的直接依據(jù)（編碼的輸入）， 是對(duì)前面總體設(shè)計(jì)工作的具體實(shí)現(xiàn)（設(shè)計(jì)的輸出）。4.1 數(shù)據(jù)結(jié)構(gòu)具體定義模塊1 相關(guān)的數(shù)據(jù)結(jié)構(gòu)，并加以解釋說(shuō)明。4.2 處理流程詳細(xì)說(shuō)明各模塊的函數(shù)之間是存在關(guān)聯(lián)關(guān)系的，為了增加可讀性，子模塊的每個(gè)功能實(shí)現(xiàn)流程在 這里說(shuō)明。（1）功能1這里描述實(shí)現(xiàn)這個(gè)子模塊功能有幾個(gè)步驟（2）功能2簡(jiǎn)單的步驟可以用文字描述，復(fù)雜的必須使用流程圖表示（可以使用函數(shù)間的調(diào)用 關(guān)系或流程來(lái)表示）。這個(gè)要和前面的總體設(shè)計(jì)模板中的5.3.1節(jié)關(guān)聯(lián)起來(lái)，是對(duì)

8、該節(jié) 的進(jìn)一步細(xì)化設(shè)計(jì)和說(shuō)明。4.3 編碼設(shè)計(jì)本節(jié)須說(shuō)明模塊1涉及的源文件，主要函數(shù)（或稱子模塊、子程序）名稱和說(shuō)明，并 用程序描述語(yǔ)言（如偽代碼）實(shí)現(xiàn)主要函數(shù)主要函數(shù)列表格式如下:主要函數(shù)名稱函數(shù)簡(jiǎn)要說(shuō)明文件一函數(shù)1簡(jiǎn)要描述函數(shù)的功能O O O ,O O O函數(shù)n文件二函數(shù)1O O O ,O O O函數(shù)n4.3.1 函數(shù)1【功能】簡(jiǎn)要描述函數(shù)的功能【參數(shù)】列出此函數(shù)的各輸入項(xiàng)，說(shuō)明其類型、名稱、含義、取值范圍等【返回值】列出此函數(shù)的各輸出項(xiàng)，說(shuō)明其類型、名稱、含義、取值范圍等【算法】用程序描述語(yǔ)言描述此函數(shù)的處理過(guò)程、 算法邏輯。對(duì)于邏輯比較簡(jiǎn)單的函數(shù)，可以概 括地說(shuō)一下算法，或者略去此項(xiàng)。對(duì)于數(shù)據(jù)結(jié)構(gòu)訪問(wèn)需要上鎖、關(guān)中斷等操作必須在這里說(shuō)明 需要提供調(diào)試內(nèi)容的，需要在這里說(shuō)明?！臼褂谜f(shuō)明】說(shuō)明該函數(shù)的外部定義包含在哪個(gè)頭文件里。說(shuō)明調(diào)用此函數(shù)時(shí)的注意事項(xiàng)，以及設(shè)計(jì)者認(rèn)為應(yīng)當(dāng)交待的其它事項(xiàng) 。4.3.2 函數(shù)2o O O O43n 函數(shù)no O O O5子模塊（實(shí)體）2詳細(xì)設(shè)計(jì)說(shuō)明用類似方式，說(shuō)明第2個(gè)模塊乃至第N個(gè)模塊的設(shè)計(jì)考慮。6附錄子系統(tǒng)定義表如果本詳細(xì)設(shè)計(jì)所對(duì)應(yīng)的最后實(shí)現(xiàn)代碼并未組織成一個(gè)子系統(tǒng)的話，就不需要填下面的 表格。填表說(shuō)明：表格項(xiàng)填寫說(shuō)明Name該子系統(tǒng)的名字Class