在詳細(xì)設(shè)計(jì)中，詳細(xì)設(shè)計(jì)文檔的編寫也是重要的一個(gè)環(huán)節(jié)。做好詳細(xì)設(shè)計(jì)的文檔編寫，對詳細(xì)設(shè)計(jì)的成功具有十分重要的作用。那么詳細(xì)設(shè)計(jì)的文檔應(yīng)該怎么寫呢？中培偉業(yè)《詳細(xì)設(shè)計(jì)與系統(tǒng)架構(gòu)最佳實(shí)踐》曾老師在這里進(jìn)行了詳細(xì)介紹。

      何謂詳細(xì)設(shè)計(jì)

詳細(xì)設(shè)計(jì)是相對概要設(shè)計(jì)而言的，是瀑布開發(fā)流程的一個(gè)重要環(huán)節(jié)，在概要設(shè)計(jì)的高層設(shè)計(jì)的基礎(chǔ)上，從邏輯上實(shí)現(xiàn)了每一模塊的功能，是編碼階段的主要參考資料，是從高層到低層、逐步精化思想的具體實(shí)現(xiàn)。

詳細(xì)設(shè)計(jì)文檔的內(nèi)容包括各個(gè)模塊的算法設(shè)計(jì)， 接口設(shè)計(jì)， 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)，交互設(shè)計(jì)等。必須寫清楚各個(gè)模塊接口公共對象的定義，列明各個(gè)模塊程序的各種執(zhí)行條件與期望的運(yùn)行效果，還要正確處理各種可能的異常。

      詳細(xì)設(shè)計(jì)的意義何在

在開發(fā)過程中，因?yàn)樾枨蠹霸O(shè)計(jì)不正確、不完整所導(dǎo)致的問題是項(xiàng)目進(jìn)度拖延、失敗的一個(gè)主要因素，而軟件系統(tǒng)的一個(gè)重要特性就是需求和設(shè)計(jì)的不斷構(gòu)建和改進(jìn)，在寫詳細(xì)設(shè)計(jì)文檔過程中， 詳細(xì)設(shè)計(jì)實(shí)際上是對系統(tǒng)的一次邏輯構(gòu)建，可以有效驗(yàn)證需求的完整性及正確性。

在不寫詳細(xì)設(shè)計(jì)文檔的情況下，如果就從概設(shè)直接進(jìn)入編碼階段，這時(shí)開發(fā)人員所能參考的資料就是需求規(guī)格說明書及頁面原型、數(shù)據(jù)庫設(shè)計(jì)等，不能直接進(jìn)行開發(fā)，需要進(jìn)行信息的溝通，把頁面原型不能體現(xiàn)的設(shè)計(jì)講清楚。這樣既容易遺忘，也容易發(fā)生問題，詳細(xì)設(shè)計(jì)文檔可以作為需求人員、總體設(shè)計(jì)人員與開發(fā)人員的溝通工具，把靜態(tài)頁面無法體現(xiàn)的設(shè)計(jì)體現(xiàn)出來，包含整體設(shè)計(jì)對模塊設(shè)計(jì)的規(guī)范，體現(xiàn)對設(shè)計(jì)上的一些決策，例如選用的算法，對一些關(guān)鍵問題的設(shè)計(jì)考慮等等，使開發(fā)人員能快速進(jìn)入開發(fā)，提高溝通效率，減少溝通問題。 

對于系統(tǒng)功能的調(diào)整，后期的維護(hù)，詳設(shè)文檔提供了模塊設(shè)計(jì)上的考慮、決策，包括模塊與整體設(shè)計(jì)的關(guān)系、模塊所引用的數(shù)據(jù)庫設(shè)計(jì)、重要操作的處理流程、重要的業(yè)務(wù)規(guī)則實(shí)現(xiàn)設(shè)計(jì)等等信息，提供了對模塊設(shè)計(jì)的概述性信息，闡明了模塊設(shè)計(jì)上的決策，配合代碼注釋，可以相對輕松讀懂原有設(shè)計(jì)。

      詳細(xì)設(shè)計(jì)文檔應(yīng)該如何寫

詳細(xì)設(shè)計(jì)的主要任務(wù)是設(shè)計(jì)每個(gè)模塊的實(shí)現(xiàn)算法、所需的局部數(shù)據(jù)結(jié)構(gòu)。詳細(xì)設(shè)計(jì)的目標(biāo)有兩個(gè)：實(shí)現(xiàn)模塊功能的算法要邏輯上正確和算法描述要簡明易懂。 傳 統(tǒng)軟件開發(fā)方法的詳細(xì)設(shè)計(jì)主要是用結(jié)構(gòu)化程序設(shè)計(jì)法。詳細(xì)設(shè)計(jì)的表示工具有圖形工具和語言工具。圖形工具有程序流程圖、PAD（Problem Analysis Diagram）圖、NS（由 Nassi和 Shneidermen開發(fā)，簡稱 NS）圖。語言工具有偽碼和 PDL（Program Design Language）等。

主要任務(wù)：

1．為每個(gè)模塊確定采用的算法，選擇某種適當(dāng)?shù)墓ぞ弑磉_(dá)算法的過程，寫出模塊的詳細(xì)過程性描述；

2．確定每一模塊使用的數(shù)據(jù)結(jié)構(gòu)；

3．確定模 塊接口的細(xì)節(jié)，包括對系統(tǒng)外部的接口和用戶界面，對系統(tǒng)內(nèi)部其它模塊的接口，以及模塊輸入數(shù)據(jù)、輸出數(shù)據(jù)及局部數(shù)據(jù)的全部細(xì)節(jié)。 在詳細(xì)設(shè)計(jì)結(jié)束時(shí)，應(yīng)該把上述結(jié)果寫入詳細(xì)設(shè)計(jì)說明書，并且通過復(fù)審形成正式文檔。交付給下一階段（編碼階段）的工作依據(jù)。

4．要為每一個(gè)模塊設(shè)計(jì)出一組測試用例，以便在編碼階段對模塊代碼（即程序）進(jìn)行預(yù)定的測試，模塊的測試用例是軟件測試計(jì)劃的重要組成部分，通常應(yīng)包括輸入數(shù)據(jù)，期 望輸出等內(nèi)容。

詳細(xì)設(shè)計(jì)的工具：

1．圖形工具利用圖形工具可以把過程的細(xì)節(jié)用圖形描述出來。

2．表格工具可以用一張表來描述過程的細(xì)節(jié)，在這張表中列出了各種可能的操作和相應(yīng)的條件。

3．語言工具用某種高級語言（稱之為偽碼）來描述過程的細(xì)節(jié)。