項(xiàng)目開(kāi)發(fā)詳細(xì)設(shè)計(jì)說(shuō)明書(shū)超好用模板完整

1、<XX系統(tǒng)>詳細(xì)設(shè)計(jì)說(shuō)明書(shū)XX有限公司修訂記錄日期修訂版本修改描述作者審核目 錄第一章概述51.1.應(yīng)用模塊的目的51.2.應(yīng)用模塊總體描述51.3.應(yīng)用模塊接口描述51.4.假設(shè)條件5第二章設(shè)計(jì)模式（Design pattern）6第三章類設(shè)計(jì)73.1.分塊類圖83.1.1.<類圖1>83.1.2.<類圖n>83.2.整體繼承關(guān)系83.3.類描述93.3.1.<類名1> Class Description93.3.2.<類名n> Class Description10第四章交互圖124.1.<情景編號(hào)1: 情景名稱>12

2、4.1.1.交互圖124.1.2.例外情況及條件134.2.<情景編號(hào)n: 情景名稱>13第五章?tīng)顟B(tài)圖145.1.<狀態(tài)圖編號(hào)1:狀態(tài)圖名稱>145.2.<狀態(tài)圖編號(hào)n:狀態(tài)圖名稱>15第六章時(shí)序流程圖16第七章用戶界面設(shè)計(jì)說(shuō)明187.1.用戶界面關(guān)系187.2.用戶界面具體描述187.2.1.<界面編號(hào)1:界面名稱187.2.2.<界面編號(hào)N:界面名稱19第八章測(cè)試考慮20第九章附錄219.1.附錄A 代碼舉例219.2.附錄B 設(shè)計(jì)問(wèn)題219.2.1.<設(shè)計(jì)問(wèn)題1>219.2.2.<設(shè)計(jì)問(wèn)題n>21第一章 概述1.1.

3、 應(yīng)用模塊的目的請(qǐng)明確客戶建立應(yīng)用模塊的目的。1.2. 應(yīng)用模塊總體描述描述應(yīng)用模塊的總體功能。 1.3. 應(yīng)用模塊接口描述簡(jiǎn)要描述本應(yīng)用模塊的公共接口，具體接口會(huì)在相應(yīng)的類中進(jìn)行具體描述。建議采用列表的方式。1.4. 假設(shè)條件列出在問(wèn)題領(lǐng)域，項(xiàng)目方案及其它影響系統(tǒng)設(shè)計(jì)的可能方面內(nèi)，應(yīng)當(dāng)成立的假設(shè)條件。包括系統(tǒng)的約束條件和應(yīng)遵循的標(biāo)準(zhǔn)。第二章 設(shè)計(jì)模式（Design pattern）請(qǐng)列出本模塊設(shè)計(jì)時(shí)使用的設(shè)計(jì)模式，請(qǐng)參考 “Design Patterns” By Erich Gramma, Helm, Johnson & Vlissides, gang of four ISBN 0-

4、201-63361-z (中文設(shè)計(jì)模式-機(jī)械工業(yè)出版社)。第三章 類設(shè)計(jì)類圖(Class Diagram)描述類和類之間的靜態(tài)關(guān)系。與數(shù)據(jù)模型不同,它不僅顯示了信息的結(jié)構(gòu),同時(shí)還描述了系統(tǒng)的行為。 在類圖的基礎(chǔ)上，利用狀態(tài)圖、關(guān)系圖等進(jìn)一步描述了系統(tǒng)其他方面的特性。類圖主要描述了：· 類（包括類的實(shí)例）· 屬性（表示知識(shí)型責(zé)任或數(shù)據(jù)）· 方法（表示操作責(zé)任或功能）· 類之間的關(guān)聯(lián)關(guān)系· 類之間的聚合關(guān)系· 在父類及子類之間的繼承關(guān)系· 正式或非正式的約束描述（可選）本節(jié)針對(duì)每個(gè)構(gòu)件的進(jìn)行了詳細(xì)描述， 記錄每個(gè)類的實(shí)例數(shù)，每個(gè)

5、實(shí)例的占用數(shù)據(jù)庫(kù)空間的平均大小等信息。類圖的設(shè)計(jì)在整個(gè)項(xiàng)目生命周期內(nèi)通過(guò)迭代的方法得到。方案的復(fù)雜程度決定迭代的次數(shù)。· 在考慮初始(initial)或概念(conceptual)角度類圖時(shí)，我們討論系統(tǒng)作什麼，該階段即傳統(tǒng)意義上的分析階段，通過(guò)理解業(yè)務(wù)模型的哪些業(yè)務(wù)模型應(yīng)在軟件系統(tǒng)中實(shí)現(xiàn)來(lái)定義問(wèn)題和需求。在這點(diǎn)上設(shè)計(jì)保持技術(shù)中立，但并不意味著絲毫不考慮技術(shù)，因?yàn)榇藭r(shí)對(duì)于如何構(gòu)造軟件系統(tǒng)的決定不是首要的關(guān)注問(wèn)題。· 下一步，設(shè)計(jì)邏輯(logical)或具體(specification)角度類圖時(shí)，開(kāi)始關(guān)心系統(tǒng)如何實(shí)施和定義方案的整體結(jié)構(gòu)。諸如并行及分發(fā)，協(xié)作及共享，交易及存

6、儲(chǔ)，用戶界面性能，及系統(tǒng)接口例如通訊接口。在設(shè)計(jì)階段，設(shè)計(jì)依賴于技術(shù)和架構(gòu)，同時(shí)設(shè)計(jì)決策也會(huì)影響技術(shù)和架構(gòu)。· 最后的迭代是設(shè)計(jì)物理或?qū)嵤┙嵌阮悎D，基于所選的實(shí)施語(yǔ)言細(xì)化架構(gòu)設(shè)計(jì)。為了處理特定的實(shí)施細(xì)節(jié)，我們可能引入新的類或?qū)ΜF(xiàn)有的類進(jìn)行重新定制。請(qǐng)明確本節(jié)描述的是何種角度的類圖。類圖的目的在于通過(guò)研究業(yè)務(wù)、用戶及系統(tǒng)的需求，制定全面的軟件模型。創(chuàng)建完善的類圖有助于完成如下工作:· 通過(guò)研究系統(tǒng)中包含的對(duì)象，優(yōu)化并精簡(jiǎn)系統(tǒng)。· 是系統(tǒng)應(yīng)用架構(gòu)某些層次設(shè)計(jì)的出發(fā)點(diǎn)，如用戶界面、數(shù)據(jù)庫(kù)建模。· 通過(guò)分析問(wèn)題所在及其相關(guān)領(lǐng)域，恰當(dāng)建立對(duì)象模型，有助于明確分工，

7、以支持并行開(kāi)發(fā)。· 通過(guò)使用簡(jiǎn)潔明了的表示方法，進(jìn)一步確認(rèn)系統(tǒng)設(shè)計(jì)。· 全面考慮使用合適的應(yīng)用設(shè)計(jì)模型、方法，避免不必要的重復(fù)工作。· 遵循正確的設(shè)計(jì)原則，方法以提高設(shè)計(jì)質(zhì)量。在開(kāi)發(fā)組合客戶中更好的理解系統(tǒng)的設(shè)計(jì)有助于系統(tǒng)的重復(fù)利用和增量開(kāi)發(fā)。使用CASE工具生成圖表。3.1. 分塊類圖本段按照模塊的不同部分的分塊描述類圖。對(duì)于小的模塊不須分塊。3.1.1. <類圖1>畫(huà)一個(gè)類圖僅描述與該部分相關(guān)的那些特征。3.1.2. <類圖n>對(duì)每個(gè)部分重復(fù)上面的段落要求。3.2. 整體繼承關(guān)系下面的圖表描述整個(gè)應(yīng)用模塊的類圖，在此僅顯示類名及類型的。

8、3.3. 類描述本章描述上述章節(jié)中提到類的詳細(xì)信息。若有可能，使用CASE工具生成這些類描述。類列表：請(qǐng)?jiān)陬惷鎏峁┻B接指向類的具體描述。類名簡(jiǎn)要描述是否為接口類3.3.1. <類名1> Class DescriptionClassCSampleXXXXPackageClass Formatpublic class CSampleXXXXExtendsImplementsPropertiesNameType Default ValuePub/Prv/ProGetSetPurposeMethodsName(Pub/Prv/Pro)ParametersReturn ValueExcep

9、tionsDescriptionEventsNameConditionParametersPurpose約束條件 （可選）實(shí)例個(gè)數(shù) （可選）實(shí)例平均大小 （可選）pseudo -Code for Important Method(重要方法偽碼)注：Pub/Prv/Pro 代表private, protected, public3.3.2. <類名n> Class DescriptionClassCSampleXXXXPackageClass Formatpublic class CSampleXXXXExtendsImplementsPropertiesNameType Defau

10、lt ValuePub/Prv/ProGetSetPurposeMethodsName(Pub/Prv/Pro)ParametersReturn ValueExceptionsDescriptionEventsNameConditionParametersPurpose約束條件 （可選）實(shí)例個(gè)數(shù) （可選）實(shí)例平均大小 （可選）pseudo -Code for Important Method(重要方法偽碼)注：Pub/Prv/Pro 代表private, protected, public第四章 交互圖交互圖以圖形方式描述了系統(tǒng)之間的交互關(guān)系。初始的交互圖僅顯示分析階段主要業(yè)務(wù)對(duì)象間主要的消息

11、流動(dòng)。后續(xù)的交互圖中包含更多的控制類， 接口類，通訊，分布和存儲(chǔ)等功能類。初始行為僅描述使用案例或具體情景中所描述的功能，后續(xù)交互圖中會(huì)描述更多系統(tǒng)內(nèi)部的行為。交互圖是實(shí)例級(jí)的圖，它描述了具體對(duì)象實(shí)例間消息的溝通及參數(shù)的傳遞，描述了系統(tǒng)動(dòng)態(tài)交互。交互圖作為功能性需求說(shuō)明和類圖之間的橋梁，幫助確定對(duì)象行為，發(fā)現(xiàn)問(wèn)題，協(xié)助設(shè)計(jì)決定，選擇其他設(shè)計(jì)方法。作為類圖的補(bǔ)充。交互圖也可幫助評(píng)估類的設(shè)計(jì)是否能滿足功能性需求，交互圖和類圖都是疊代開(kāi)發(fā)的。本文僅對(duì)復(fù)雜情況使用交互圖描述。請(qǐng)為不同的情景進(jìn)行編號(hào)。 并在交互圖列表的情景編號(hào)處提供聯(lián)接。交互圖列表：情景編號(hào)情景名稱情景描述相關(guān)使用案例4.1. <

12、情景編號(hào)1: 情景名稱>4.1.1. 交互圖描述主要的流程，建議使用Rational Rose 工具示例：4.1.2. 例外情況及條件描述可能的例外情況及條件。可選。4.2. <情景編號(hào)n: 情景名稱>對(duì)每個(gè)交互圖重復(fù)上面的段落要求。第五章 狀態(tài)圖狀態(tài)圖描述了某一具體類的行為或生命周期。它描述了其可能的狀態(tài)表現(xiàn)，由外界刺激引起的狀態(tài)變化。狀態(tài)圖描述了某個(gè)類與其它類交互時(shí)復(fù)雜的狀態(tài)變化。以圖形方式描述狀態(tài)相關(guān)的行為能力，闡明了觸發(fā)的事件，觸發(fā)條件，及相應(yīng)的行為。本章描述了復(fù)雜的主要的狀態(tài)轉(zhuǎn)換。請(qǐng)為不同的狀態(tài)圖進(jìn)行編號(hào)。 并在狀態(tài)圖列表的編號(hào)處提供聯(lián)接。狀態(tài)圖列表：狀態(tài)圖編號(hào)名稱

13、描述相關(guān)類5.1. <狀態(tài)圖編號(hào)1:狀態(tài)圖名稱>示例：建議使用Rational Rose 工具必要時(shí)可提供下表幫助描述。狀態(tài)子狀態(tài)入口動(dòng)作內(nèi)部動(dòng)作出口動(dòng)作狀態(tài)子狀態(tài)事件條件變化新?tīng)顟B(tài)5.2. <狀態(tài)圖編號(hào)n:狀態(tài)圖名稱>對(duì)每個(gè)交互圖重復(fù)上面的段落要求。第六章 時(shí)序流程圖通過(guò)時(shí)序圖描述一個(gè)事件、功能的順序處理過(guò)程。圖示方式表叔，并文字描述每步過(guò)程。示例：第七章 用戶界面設(shè)計(jì)說(shuō)明用戶界面設(shè)計(jì)說(shuō)明描述用戶期待看到的屏幕序列（窗口，對(duì)話框，及提示）及其與其與系統(tǒng)的交互。用戶界面設(shè)計(jì)也包括詳細(xì)的屏幕設(shè)計(jì)、對(duì)象、窗口小部件、選項(xiàng)、菜單、按鍵、視覺(jué)、對(duì)話框、按鍵狀態(tài)、屏幕行為、用戶意

14、外處理及錯(cuò)誤信息、及所有的外部用戶幫助。7.1. 用戶界面關(guān)系使用圖顯示用戶界面的關(guān)系。通過(guò)矩形表示每個(gè)界面。確保窗口的類名能反映該窗口的業(yè)務(wù)并且與項(xiàng)目編碼命名規(guī)則一致。如果用戶能從某窗口打開(kāi)另一個(gè)窗口，請(qǐng)用帶剪頭的連線表示。附上界面列表。在編號(hào)處應(yīng)提供超級(jí)連接到相應(yīng)的頁(yè)面描述。7.2. 用戶界面具體描述本章描述系統(tǒng)中每個(gè)界面的詳細(xì)設(shè)計(jì)。必要時(shí)附上屏幕抓取得界面。7.2.1. <界面編號(hào)1:界面名稱· 內(nèi)部組件關(guān)系典型地以O(shè)MT模型的方式，顯示界面與界面內(nèi)組件的關(guān)系。· 域描述針對(duì)每個(gè)域進(jìn)行具體描述，包括類型，長(zhǎng)短，是否是必須錄入的域。屬性注釋類型標(biāo)識(shí)可寫(xiě)排列（左，右，居中）數(shù)據(jù)類型是否按內(nèi)容變換域?qū)挸跏贾底畲箝L(zhǎng)度· Tab 鍵順序 解釋視圖的Tab鍵順序。指出光標(biāo)起始點(diǎn)位置。· 行為描述每個(gè)具體行為的詳細(xì)信息：行為連接注釋 · 幫助信息定義幫助面板及與視圖相關(guān)的其它幫助信息細(xì)節(jié)。· 意外事件處理及錯(cuò)誤信息描述如何處理錯(cuò)誤及對(duì)用戶動(dòng)作發(fā)生了何種響應(yīng)。7.2.2. <界