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

1、標(biāo)準(zhǔn)文檔實(shí)用文案XX系統(tǒng),詳細(xì)設(shè)計(jì)說(shuō)明書XX有限公司詳細(xì)設(shè)計(jì)說(shuō)明書修訂記錄日期修訂版本修改描述作者審核頁(yè)碼：2日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書目 錄 TOC o 1-5 h z HYPERLINK l bookmark7 o Current Document 第一章概述 5 HYPERLINK l bookmark9 o Current Document 應(yīng)用模塊的目的 5 HYPERLINK l bookmark11 o Current Document 應(yīng)用模塊總體描述 5 HYPERLINK l bookmark13 o Current Document 應(yīng)用模塊接口描述 5 HYP

2、ERLINK l bookmark15 o Current Document 假設(shè)條件 5第二章設(shè)計(jì)模式(Design pattern ) 6 HYPERLINK l bookmark17 o Current Document 第三章類設(shè)計(jì) 7 HYPERLINK l bookmark19 o Current Document 分塊類圖 888 HYPERLINK l bookmark21 o Current Document 整體繼承關(guān)系 8 HYPERLINK l bookmark23 o Current Document 類描述 9ClassDescription9ClassDescri

3、ption10 TOC o 1-5 h z HYPERLINK l bookmark25 o Current Document 第四章交互圖 12 HYPERLINK l bookmark27 o Current Document 12交互圖12例 外 情 況 及 條 件 13 HYPERLINK l bookmark29 o Current Document 13 HYPERLINK l bookmark31 o Current Document 第五章狀態(tài)圖 14 HYPERLINK l bookmark33 o Current Document 5.1. 14頁(yè)碼：3日期：2019-5-

4、6詳細(xì)設(shè)計(jì)說(shuō)明書5.2.15 TOC o 1-5 h z HYPERLINK l bookmark37 o Current Document 第六章時(shí)序流程圖 16 HYPERLINK l bookmark39 o Current Document 第七章用戶界面設(shè)計(jì)說(shuō)明 18 HYPERLINK l bookmark41 o Current Document 用戶界面關(guān)系 18 HYPERLINK l bookmark43 o Current Document 用戶界面具體描述 18界18n19第八章測(cè)試考慮第九章附錄附錄A代碼舉例附錄B設(shè)計(jì)問(wèn)題設(shè)計(jì)問(wèn)21設(shè)計(jì)問(wèn)21日期：2019-5-6詳細(xì)

5、設(shè)計(jì)說(shuō)明書第一章概述應(yīng)用模塊的目的請(qǐng)明確客戶建立應(yīng)用模塊的目的。應(yīng)用模塊總體描述描述應(yīng)用模塊的總體功能。應(yīng)用模塊接口描述簡(jiǎn)要描述本應(yīng)用模塊的公共接口，具體接口會(huì)在相應(yīng)的類中進(jìn)行具體描述。建議采用列表的方式。假設(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)。頁(yè)碼：5日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書第二章設(shè)計(jì)模式(Design pattern )請(qǐng)列出本模塊設(shè)計(jì)時(shí)使用的設(shè)計(jì)模式， 請(qǐng)參考“Design Patterns ” By Erich Gramma, Helm, Johnson & Vlissides, gang of

6、four ISBN 0-201-63361-z ( 中 文設(shè)計(jì)模式-機(jī)械工業(yè)出版社)。頁(yè)碼：6日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書第三章類設(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è)實(shí)例的占用數(shù)據(jù)庫(kù)空間的平

7、均大小等信息。類圖的設(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） 或具體（specfication） 角度類圖時(shí)，開始 關(guān)心系統(tǒng)如何實(shí)施和定義方案的整體結(jié)構(gòu)。諸如并行及分發(fā)，協(xié)作及共 享，交易及存儲(chǔ)，用戶界面性能，及系統(tǒng)接口例如通訊接口

8、。在設(shè)計(jì)階 段，設(shè)計(jì)依賴于技術(shù)和架構(gòu)，同時(shí)設(shè)計(jì)決策也會(huì)影響技術(shù)和架構(gòu)。頁(yè)碼：7日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書最后的迭代是設(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ì)象模型，有助于明確分工, 以支持并行開發(fā)。通過(guò)使用簡(jiǎn)潔明了的表示方法

9、，進(jìn)一步確認(rèn)系統(tǒng)設(shè)計(jì)。全面考慮使用合適的應(yīng)用設(shè)計(jì)模型、方法，避免不必要的重復(fù)工作。遵循正確的設(shè)計(jì)原則，方法以提高設(shè)計(jì)質(zhì)量。在開發(fā)組合客戶中更好的理解系統(tǒng)的設(shè)計(jì)有助于系統(tǒng)的重復(fù)利用和增量開 發(fā)。使用CASE：具生成圖表。分塊類圖本段按照模塊的不同部分的分塊描述類圖。對(duì)于小的模塊不須分塊。畫一個(gè)類圖僅描述與該部分相關(guān)的那些特征。對(duì)每個(gè)部分重復(fù)上面的段落要求。整體繼承關(guān)系頁(yè)碼：8日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書下面的圖表描述整個(gè)應(yīng)用模塊的類圖，在此僅顯示類名及類型的類描述本章描述上述章節(jié)中提到類的詳細(xì)信息。若有可能，使用CASE：具生成這些類描述類列表：請(qǐng)?jiān)陬惷鎏峁┻B接指向類的具體描述。類名簡(jiǎn)

10、要描述是否為接口類日期：2019-5-6頁(yè)碼：9詳細(xì)設(shè)計(jì)說(shuō)明書約束條件（可選）實(shí)例個(gè)數(shù)（可選）實(shí)例平均大?。蛇x）pseudo -Code for Important Method(重要方法偽碼)注：Pub/Prv/Pro 代表 private, protected, public Class DescriptionClassCSampleXXXXPackageClass Formatpublic class CSampleXXXXExtendsImplementsPropertiesNameTypeDefaultValuePub/Prv/ProGetSetPurposeMethodsName

11、(Pub/Prv/Pro)ParametersReturn ValueExceptionsDescriptionEventsNameConditionParametersPurpose約束條件（可選）頁(yè)碼：10日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書實(shí)例個(gè)數(shù)（可選）實(shí)例平均大?。蛇x）pseudo -Code for Important Method（重要方法偽碼）注：Pub/Prv/Pro 代表 private, protected, public頁(yè)碼：11日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書第四章 交互圖交互圖以圖形方式描述了系統(tǒng)之間的交互關(guān)系。初始的交互圖僅顯示分析階段主要業(yè)務(wù)對(duì)象間主要的消

12、息流動(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ì)是否能滿足功能性需求，交互圖和類圖都是疊 代開發(fā)的。本文僅對(duì)復(fù)雜情況使用交互圖描述。請(qǐng)為不同的情景進(jìn)行編號(hào)。 并在交互圖列表的情景編號(hào)處提供聯(lián)接。交互圖列表:情景編號(hào)情景名稱，情景描述相關(guān)使用案例情

13、景編號(hào)1:情景名稱交互圖描述主要的流程，建議使用 Rational Rose 工具 示例：頁(yè)碼：12日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書例外情況及條件描述可能的例外情況及條件?？蛇x。情景編號(hào)n:情景名稱對(duì)每個(gè)交互圖重復(fù)上面的段落要求。頁(yè)碼：13日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書第五章狀態(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)接

14、。狀態(tài)圖列表：狀態(tài)圖編號(hào)名稱描述相關(guān)類狀態(tài)圖編號(hào)1:狀態(tài)圖名稱示例:One Final StateAnodier Firial State建議使用Rational Rose 工具必要時(shí)可提供下表幫助描述。狀態(tài)子狀態(tài)入口動(dòng)作內(nèi)部動(dòng)作出口動(dòng)作頁(yè)碼：14日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書狀態(tài)子狀態(tài)事件條件變化新狀態(tài)狀態(tài)圖編號(hào)n:狀態(tài)圖名稱對(duì)每個(gè)交互圖重復(fù)上面的段落要求。頁(yè)碼：15日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書第六章時(shí)序流程圖通過(guò)時(shí)序圖描述一個(gè)事件、功能的順序處理過(guò)程 圖示方式表叔，并文字描述每步過(guò)程。示例:newDir :Dir輔DtrDf 餡叫 口日期：2019-5-6createDir

15、:getAuthsavDiri$aveAu1h*A 1出II頁(yè)碼：16瀏覽會(huì)KM S50 Agenl詳細(xì)設(shè)計(jì)說(shuō)明書(LDP)1用戶登錄庖用或門戶二儆 n假,S S OToKen的有效性1個(gè)訃次工效把請(qǐng)求里定向認(rèn)證平臺(tái)請(qǐng)求黃源傳送認(rèn)證平臺(tái)3授極模塊相康用戶登錄界面i產(chǎn)生 SESsltin4用戶填耳笄世交信息5,騙證用戶7 essicin信息交互8.臉譏用戶魂源訪問(wèn)權(quán)邑Toke罐息垂定向Agent；1 9.返回用戶有權(quán)限的信息 T頁(yè)碼：17日期：2019-5-6詳細(xì)設(shè)計(jì)說(shuō)明書第七章用戶界面設(shè)計(jì)說(shuō)明用戶界面設(shè)計(jì)說(shuō)明描述用戶期待看到的屏幕序列（窗口，對(duì)話框，及提示） 及其與其與系統(tǒng)的交互。用戶界面設(shè)計(jì)

16、也包括詳細(xì)的屏幕設(shè)計(jì)、對(duì)象、窗口小部 件、選項(xiàng)、菜單、按鍵、視覺、對(duì)話框、按鍵狀態(tài)、屏幕行為、用戶意外處理及 錯(cuò)誤信息、及所有的外部用戶幫助。用戶界面關(guān)系使用圖顯示用戶界面的關(guān)系。通過(guò)矩形表示每個(gè)界面。確保窗口的類名能反 映該窗口的業(yè)務(wù)并且與項(xiàng)目編碼命名規(guī)則一致。 如果用戶能從某窗口打開另一個(gè) 窗口，請(qǐng)用帶剪頭的連線表示。附上界面列表。在編號(hào)處應(yīng)提供超級(jí)連接到相應(yīng) 的頁(yè)面描述。用戶界面具體描述本章描述系統(tǒng)中每個(gè)界面的詳細(xì)設(shè)計(jì)。必要時(shí)附上屏幕抓取得界面。界面編號(hào)1:界面名稱內(nèi)部組件關(guān)系典型地以O(shè)MT型的方式，顯示界面與界面內(nèi)組件的關(guān)系。域描述日期：2019-5-6針對(duì)每個(gè)域進(jìn)行具體描述，包括類型，長(zhǎng)短，是否是必須錄入的域?qū)傩宰⑨岊愋蜆?biāo)識(shí)可寫排列（左，右，居中）數(shù)據(jù)類型是否按內(nèi)容變換域?qū)掜?yè)碼：18詳細(xì)設(shè)計(jì)說(shuō)明書屬性初始值最大長(zhǎng)度 Tab鍵順序解釋視圖的Tab順序。指出光標(biāo)起始點(diǎn)位置行為描述每個(gè)具體行為的詳細(xì)信息:行為連接注釋幫助信息定義幫助面板及與視圖相關(guān)的其它幫助信息細(xì)節(jié)意外事件處理及錯(cuò)誤