在詳細(xì)設(shè)計(jì)中,詳細(xì)設(shè)計(jì)文檔的編寫也是重要的一個環(huán)節(jié)。做好詳細(xì)設(shè)計(jì)的文檔編寫,對詳細(xì)設(shè)計(jì)的成功具有十分重要的作用。那么詳細(xì)設(shè)計(jì)的文檔應(yīng)該怎么寫呢?中培偉業(yè)現(xiàn)在來為你做解答。
何謂詳細(xì)設(shè)計(jì)
詳細(xì)設(shè)計(jì)是相對概要設(shè)計(jì)而言的,是瀑布開發(fā)流程的一個重要環(huán)節(jié),在概要設(shè)計(jì)的高層設(shè)計(jì)的基礎(chǔ)上,從邏輯上實(shí)現(xiàn)了每一模塊的功能,是編碼階段的主要參考資料,是從高層到低層、逐步精化思想的具體實(shí)現(xiàn)。
詳細(xì)設(shè)計(jì)文檔的內(nèi)容包括各個模塊的算法設(shè)計(jì), 接口設(shè)計(jì), 數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì),交互設(shè)計(jì)等。必須寫清楚各個模塊/接口/公共對象的定義,列明各個模塊程序的各種執(zhí)行條件與期望的運(yùn)行效果,還要正確處理各種可能的異常。
詳細(xì)設(shè)計(jì)的意義何在
在開發(fā)過程中,因?yàn)樾枨蠹霸O(shè)計(jì)不正確、不完整所導(dǎo)致的問題是項(xiàng)目進(jìn)度拖延、失敗的一個主要因素,而軟件系統(tǒng)的一個重要特性就是需求和設(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)入編碼階段,這時開發(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ì)。
想了解更多IT資訊,請?jiān)L問中培偉業(yè)官網(wǎng):中培偉業(yè)