詳細(xì)設(shè)計(jì)說明書08271

1、1 引言 1.1 編寫目的：闡明編寫詳細(xì)設(shè)計(jì)說明書的目的，指明讀者對象。 1.2 項(xiàng)目背景：應(yīng)包括項(xiàng)目的來源和主管部門等。 1.3 定義：列出本文檔中所用到的專門術(shù)語的定義和縮寫詞的愿意。 1.4 參考資料： 列出有關(guān)資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源 項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級機(jī)關(guān)的批文；項(xiàng)目開發(fā)計(jì)劃；需求規(guī)格說明書；概要設(shè)計(jì)說明書；測試計(jì)劃（初稿）；用戶操作手冊 文檔所引用的資料、軟件開發(fā)的標(biāo)準(zhǔn)或規(guī)范。 2 總體設(shè)計(jì) 2.1 需求概述 2.2 軟件結(jié)構(gòu)：如給出軟件系統(tǒng)的結(jié)構(gòu)圖。 3 程序描述 3.1 逐個模塊給出以下說明： 功能 性能 輸入項(xiàng)目 輸出項(xiàng)目 3.2

2、算法：模塊所選用的算法。 3.3 程序邏輯：詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用：標(biāo)準(zhǔn)流程圖；PDL語言；N-S圖；判定表等描述算法的圖表。 3.4 接口 存儲分配 限制條件 3.5測試要點(diǎn)：給出測試模塊的主要測試要求。1 概述1.1 系統(tǒng)簡述對系統(tǒng)要完成什么，所面向的用戶以及系統(tǒng)運(yùn)行的環(huán)境的簡短描述，這部分主要來源于需求說明書的開始部分。1.2 軟件設(shè)計(jì)目標(biāo)這部分論述整個系統(tǒng)的設(shè)計(jì)目標(biāo)，明確地說明哪些功能是系統(tǒng)決定實(shí)現(xiàn)而哪些時不準(zhǔn)備實(shí)現(xiàn)的。同時，對于非功能性的需求例如性能、可用性等，亦需提及。需求規(guī)格說明書對于這部分的內(nèi)容來說是很重要的參考，看看其中明確了的功能性以及非功能性的需求。這部分必須說清

3、楚設(shè)計(jì)的全貌如何，務(wù)必使讀者看后知道將實(shí)現(xiàn)的系統(tǒng)有什么特點(diǎn)和功能。在隨后的文檔部分，將解釋設(shè)計(jì)是怎么來實(shí)現(xiàn)這些的。1.3 參考資料列出本文檔中所引用的參考資料。（至少要引用需求規(guī)格說明書）1.4 修訂版本記錄列出本文檔修改的歷史紀(jì)錄。必須指明修改的內(nèi)容、日期以及修改人。2 術(shù)語表對本文檔中所使用的各種術(shù)語進(jìn)行說明。如果一些術(shù)語在需求規(guī)格說明書中已經(jīng)說明過了，此處不用再重復(fù)，可以指引讀者參考需求說明。3 用例此處要求系統(tǒng)用用例圖表述（UML），對每個用例（正常處理的情況）要有中文敘述。4 設(shè)計(jì)概述4.1 簡述這部分要求突出整個設(shè)計(jì)所采用的方法（是面向?qū)ο笤O(shè)計(jì)還是結(jié)構(gòu)化設(shè)計(jì)）、系統(tǒng)的體系結(jié)構(gòu)（例如

4、客戶/服務(wù)器結(jié)構(gòu)）以及使用到的相應(yīng)技術(shù)和工具（例如OMT、Rose）4.2 系統(tǒng)結(jié)構(gòu)設(shè)計(jì)這部分要求提供高層系統(tǒng)結(jié)構(gòu)的描述，使用方框圖來顯示主要的組件及組件間的交互。最好是把邏輯結(jié)構(gòu)同物理結(jié)構(gòu)分離，對前者進(jìn)行描述。別忘了說明圖中用到的俗語和符號。4.2.1 頂層系統(tǒng)結(jié)構(gòu)4.2.2 子系統(tǒng)1結(jié)構(gòu)4.2.3 子系統(tǒng)2結(jié)構(gòu)4.3 系統(tǒng)界面各種提供給用戶的界面以及外部系統(tǒng)在此處要予以說明。如果在需求規(guī)格說明書中已經(jīng)對用戶界面有了敘述，此處不用再重復(fù)，可以指引讀者參考需求說明。如果系統(tǒng)提供了對其它系統(tǒng)的接口，比如說從其它軟件系統(tǒng)導(dǎo)入/導(dǎo)出數(shù)據(jù)，必須在此說明。4.4 約束和假定描述系統(tǒng)設(shè)計(jì)中最主要的約束，這

5、些是由客戶強(qiáng)制要求并在需求說明書寫明的。說明系統(tǒng)是如何來適應(yīng)這些約束的。另外如果本系統(tǒng)跟其它外部系統(tǒng)交互或者依賴其它外部系統(tǒng)提供一些功能輔助，那么系統(tǒng)可能還受到其它的約束。這種情況下，要求清楚地描述與本系統(tǒng)有交互的軟件類型（比如某某某數(shù)據(jù)庫軟件，某某某EMail軟件）以及這樣導(dǎo)致的約束（比如只允許純文本的Email）。實(shí)現(xiàn)的語言和平臺也會對系統(tǒng)有約束，同樣在此予以說明。對于因選擇具體的設(shè)計(jì)實(shí)現(xiàn)而導(dǎo)致對系統(tǒng)的約束，簡要地描述你的想法思路，經(jīng)過怎么樣的權(quán)衡，為什么要采取這樣的設(shè)計(jì)等等。5 對象模型5.1 系統(tǒng)對象模型提供整個系統(tǒng)的對象模型，如果模型過大，按照可行的標(biāo)準(zhǔn)把它劃分成小塊，例如可以把客戶

6、端和服務(wù)器端的對象模型分開成兩個圖表述。對象圖應(yīng)該包含什么呢？在其中應(yīng)該包含所有的系統(tǒng)對象。這些對象都是從理解需求后得到的。要明確哪些應(yīng)該、哪些不應(yīng)該被放進(jìn)圖中。所有對象之間的關(guān)聯(lián)必須被確定并且必須指明聯(lián)系的基數(shù)（一對一、一對多還是多對多，0.1，*，1.*）。聚合和繼承關(guān)系必須清楚地確定下來。每個圖必須附有簡單的說明?？赡芙?jīng)過多次反復(fù)之后才能得到系統(tǒng)的正確的對象模型。6 對象描述在這個部分?jǐn)⑹雒總€對象的細(xì)節(jié)，它的屬性、它的方法。在這之前必須從邏輯上對對象進(jìn)行組織。你可能需要用結(jié)構(gòu)圖把對象按子系統(tǒng)劃分好。為每個對象做一個條目。在系統(tǒng)對象模型中簡要的描述它的用途、約束（如只能有一個實(shí)例），列出它

7、的屬性和方法。如果對象是存儲在持久的數(shù)據(jù)容器中，標(biāo)明它是持久對象，否則說明它是個臨時對象（transient object）。對每個對象的每個屬性詳細(xì)說明：名字、類型，如果屬性不是很直觀或者有約束（例如，每個對象的該屬性必須有一個唯一的值或者值域是有限正整數(shù)等）。對每個對象的每個方法詳細(xì)說明：方法名，返回類型，返回值，參數(shù)，用途以及使用的算法的簡要說明（如果不是特別簡單的話）。如果對變量或者返回值由什么假定的話，Pre-conditions和Post-conditions必須在此說明。列出它或者被它調(diào)用的方法需要訪問或者修改的屬性。最后，提供可以驗(yàn)證實(shí)現(xiàn)方法的測試案例。6.1 子系統(tǒng)1中的對象