軟件項(xiàng)目的詳細(xì)設(shè)計(jì)

1、.目錄一、詳細(xì)設(shè)計(jì)文檔模板1二、項(xiàng)目案例2詳細(xì)設(shè)計(jì)文檔詳細(xì)設(shè)計(jì)文檔是指在詳細(xì)設(shè)計(jì)過(guò)程中制訂詳細(xì)設(shè)計(jì)報(bào)告所依據(jù)的標(biāo)準(zhǔn)。一般說(shuō)， 詳細(xì)設(shè)計(jì)規(guī)格說(shuō)明沒(méi)有統(tǒng)一的標(biāo)準(zhǔn)， 有的是以偽代碼的方式體現(xiàn)， 最后可能與源代碼合為一體， 有的可能是一些文檔格式的。下面的詳細(xì)設(shè)計(jì)規(guī)格說(shuō)明文檔模板可以作為參照。一、詳細(xì)設(shè)計(jì)文檔模板1、導(dǎo)言1.1 目的說(shuō)明文檔的目的。1.2 范圍說(shuō)明文檔覆蓋的范圍。1.3 縮寫(xiě)說(shuō)明定義文檔中所涉及的縮寫(xiě)語(yǔ)（若無(wú)則填寫(xiě)無(wú)，不寫(xiě)）。1.4 術(shù)語(yǔ)定義定義文檔中所涉及的特定術(shù)語(yǔ)（若無(wú)則填寫(xiě)無(wú)，不寫(xiě)）。1.5 引用標(biāo)準(zhǔn)列出文檔制定所依據(jù)、引用的標(biāo)準(zhǔn)（若無(wú)則填寫(xiě)無(wú)，不寫(xiě)）。1.6 參考資料列出文檔制

2、定所需的參考資料（若無(wú)則填寫(xiě)無(wú)，不寫(xiě)，也可以放在最后寫(xiě)）。1.7 版本更新信息記錄文檔版本修改的過(guò)程，具體版本更新記錄如表XXXX所示。表 XXXX版本更新記錄修改編號(hào)修改日期修改后的版本修改位置修改內(nèi)容描述2、系統(tǒng)設(shè)計(jì)概述本節(jié)描述的主要內(nèi)容包括：（ 1）簡(jiǎn)要描述系統(tǒng)整體結(jié)構(gòu)（文字和框圖相結(jié)合）。（ 2）模塊劃分和分布（如果采用OO 技術(shù)，則可用構(gòu)件圖和包圖表示） 。（ 3）系統(tǒng)采用的技術(shù)和實(shí)現(xiàn)方法。.3、詳細(xì)設(shè)計(jì)概述本節(jié)以模塊為單位，簡(jiǎn)要描述以下內(nèi)容：（ 1）模塊用途。（ 2）模塊功能。（ 3）特別約定。4、詳細(xì)設(shè)計(jì)本節(jié)以模塊為單位，詳細(xì)描述以下內(nèi)容：（ 1）模塊的定義。（ 2）模塊的關(guān)聯(lián)。

3、（ 3）輸入 / 輸出數(shù)據(jù)說(shuō)明，包括變量的描述（重要的變量及用途），以及約束條件或限制條件。（ 4）實(shí)現(xiàn)描述 / 算法說(shuō)明，包括說(shuō)明本模塊的實(shí)現(xiàn)流程，包括條件分支和異常處理、模塊的應(yīng)用邏輯、模塊的數(shù)據(jù)邏輯。這部分可以通過(guò)流程圖或者偽代碼的方式實(shí)現(xiàn)。5、程序提交清單程序提交清單以模塊為單位分別進(jìn)行描述，格式如表XXXX所示。模塊文件名文件類型用途二、項(xiàng)目案例項(xiàng)目案例名稱：綜合信息管理平臺(tái)項(xiàng)目案例文檔： 綜合信息管理平臺(tái)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)1、 導(dǎo)言（可以不寫(xiě)）1.1 目的本文檔的目的是描述綜合信息管理平臺(tái)項(xiàng)目的詳細(xì)設(shè)計(jì)，其主要內(nèi)容包括系統(tǒng)功能簡(jiǎn)介、系統(tǒng)詳細(xì)設(shè)計(jì)、各個(gè)模塊的三層劃分、最小模塊組件的偽代碼

4、。本文檔的預(yù)期讀者是設(shè)計(jì)人員、開(kāi)發(fā)人員、項(xiàng)目管理人員、測(cè)試人員。1.2 范圍該文檔定義了系統(tǒng)的各個(gè)模塊和模塊接口， 但未確定單元的具體實(shí)現(xiàn)， 這部分內(nèi)容將在實(shí)現(xiàn)（編碼）中確定。1.3 引用標(biāo)準(zhǔn)（參照學(xué)校要求寫(xiě)）1、企業(yè)文檔格式標(biāo)準(zhǔn)V1.1，北京長(zhǎng)江軟件有限公司。2、1.4 參考資料.1、1.5 版本更新信息本文檔版本更新記錄如表X-XXX所示。表 X-XXX 版本更新記錄修改編號(hào)修改日期修改后的版本修改位置修改內(nèi)容概述00020131215V001全部初始發(fā)布2、系統(tǒng)設(shè)計(jì)概述根據(jù)綜合信息管理平臺(tái)的概要設(shè)計(jì)，系統(tǒng)分為登錄管理、帳號(hào)管理、帳號(hào)組權(quán)限管理、角色管理、日志管理、統(tǒng)計(jì)報(bào)表、平臺(tái)管理、業(yè)務(wù)

5、信息系統(tǒng)維護(hù)等模塊，它們的關(guān)系如圖XXXX所示，以下將分小節(jié)對(duì)各個(gè)部分分別進(jìn)行詳細(xì)設(shè)計(jì)。綜合信息管理平臺(tái)登錄管理業(yè)務(wù)信息系統(tǒng)管理員平臺(tái)管理員業(yè)務(wù)個(gè) 人用日統(tǒng)平信息信 息戶志計(jì)臺(tái)系統(tǒng)維護(hù)管查報(bào)管維護(hù)理詢表理帳帳權(quán)角帳 號(hào)異 常帳 號(hào)異 常號(hào)號(hào)限色角 色時(shí) 間角 色時(shí) 間管組管管變 更登 錄變 更登 錄理管理理報(bào)表操 作報(bào)表操 作理報(bào)表報(bào)表圖 XXXX模塊設(shè)計(jì)圖3、詳細(xì)設(shè)計(jì)概述由于本系統(tǒng)采用了基于Structs 體系結(jié)構(gòu)的設(shè)計(jì)，即采用MVC 的三層設(shè)計(jì)模式，采用面向?qū)ο蟮腏ava語(yǔ)言以及JSP腳本語(yǔ)言， 所以基本采用面向?qū)ο蟮脑O(shè)計(jì)方法。在整個(gè)開(kāi)發(fā)過(guò)程中，盡可能采用復(fù)用的原則，例如采用標(biāo)簽庫(kù)，統(tǒng)一數(shù)

6、據(jù)庫(kù)的基本操作，統(tǒng)一結(jié)果顯示等。本文檔的詳細(xì)設(shè)計(jì)主要是按照Struts 的 MVC 的三個(gè)層次分別描述視圖層、控制層和模.型層模塊的偽代碼，為下一步的編碼提供基礎(chǔ)。下面以登錄管理模塊為例進(jìn)行說(shuō)明，但算法流程并未給出。若模塊多，以做得最好的模塊為例來(lái)講。對(duì)于每一個(gè)視圖、控制器、模型需要畫(huà)出詳細(xì)的算法流程圖等，共同的內(nèi)容可以先寫(xiě)。4、登錄管理模塊（下面以登錄模塊為例寫(xiě)）登錄管理模塊負(fù)責(zé)用戶的登錄。系統(tǒng)框架可分成三層結(jié)構(gòu)，即視圖層、控制層和模型層，具體如表 XXXX所示。表 XXXX登錄管理的三層模塊視圖控制器模型login.jspLoginFormLoginActionDB.javamain.js

7、pConstants.javaUser.jav4.1 視圖層根據(jù)上述的功能介紹，視圖頁(yè)面設(shè)計(jì)如表XXXX所示。表 XXXX登錄管理模塊的頁(yè)面設(shè)計(jì)界面JSP功能描述登錄界面login.jsp登錄的主頁(yè)面主頁(yè)main.jsp管理主頁(yè)面頁(yè)面中部center.jsp復(fù)用頁(yè)面：頁(yè)面中心部分頁(yè)面上端top.jsp復(fù)用頁(yè)面：頁(yè)面上部分頁(yè)面左端left.jsp復(fù)用頁(yè)面：頁(yè)面左部分頁(yè)面下端bottom.jsp復(fù)用頁(yè)面：頁(yè)面下部分根據(jù)界面流的設(shè)計(jì)可以確定各個(gè)界面的訪問(wèn)入口以及界面之間的切換關(guān)系，頁(yè)面流程如圖 XXXX所示。login.jspmain.jsp圖 XXXX登錄管理的頁(yè)面流程4.2 控制層登錄管理的控制層主要是設(shè)計(jì)用戶的登錄事件(Action) 的流程控制。 表 X-XXX列出了每個(gè) Action 的入口（即調(diào)用 Action 的組件）、傳遞 Action 的 ActionForm 以及出口（即 Action將請(qǐng)求發(fā)送到目標(biāo)組件）。表 XXXX登錄管理的控制層設(shè)計(jì)事件Action入口ActionForm出口用戶登錄LoginActionlogin.jspLoginFormmain.jsp4.3模型層登錄管理的模型組件負(fù)責(zé)完成用戶信息的數(shù)據(jù)庫(kù)操作的業(yè)務(wù)邏輯模型，建立封裝了用戶信息的