詳細(xì)設(shè)計(jì)說(shuō)明書(shū)模版

1、精選優(yōu)質(zhì)文檔-傾情為你奉上密級(jí)：機(jī)密文檔編號(hào)：XXX_TS_TEMP_XXSJSMS版本號(hào)：V2.0【項(xiàng)目名稱】詳細(xì)設(shè)計(jì)說(shuō)明書(shū)模板編寫(xiě)人：XXX批準(zhǔn)人：XXX生效日期：2017年1月6日版權(quán)信息本文件涉及之信息，屬XXX所有。未經(jīng)XXX允許，文件中的任何部分都不能以任何形式向第三方散發(fā)。文檔修訂記錄版本號(hào)修訂日期修訂人修訂說(shuō)明修訂狀態(tài)審核日期審核人批準(zhǔn)人V0.12016-12-1XXX創(chuàng)建A2016-12-1XXXXXXV1.02016-12-28XXX調(diào)整需求分析方法M2016-12-29XXXXXXV2.02017-1-4XXX更換使用模板M2017-1-6XXXXXX修訂狀態(tài)：A-增加，

2、M-修改，D-刪除日期格式：YYYY-MM-DD專心-專注-專業(yè)目 錄1 概述1.1 編寫(xiě)目的<此處填寫(xiě)本文檔的目的><例如：XXX項(xiàng)目的目的是：根據(jù)XXX需求規(guī)格說(shuō)明書(shū)進(jìn)行詳細(xì)設(shè)計(jì)>1.2 適用范圍<此處填寫(xiě)本文檔的適用范圍等>1.3 術(shù)語(yǔ)和縮寫(xiě)<此處填寫(xiě)本文檔中所特有的術(shù)語(yǔ)和縮寫(xiě)，常用的術(shù)語(yǔ)和縮寫(xiě)統(tǒng)一編寫(xiě)在一個(gè)規(guī)范文檔中>術(shù)語(yǔ)和縮寫(xiě)解釋備注1.4 參考資料指出為完成本文檔所需要的參考資料，包括 a屬于本項(xiàng)目的其它已發(fā)表的文件； b本文件中各處引用到的文件資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能

3、夠取得這些文件的來(lái)源。>參考文件備注XXXX項(xiàng)目需求規(guī)格說(shuō)明書(shū)XXXX項(xiàng)目系統(tǒng)概要設(shè)計(jì)報(bào)告2 角色和職責(zé)角色職責(zé)項(xiàng)目經(jīng)理l 指導(dǎo)和審查數(shù)據(jù)庫(kù)的詳細(xì)設(shè)計(jì)系統(tǒng)分析員l 負(fù)責(zé)數(shù)據(jù)庫(kù)的詳細(xì)設(shè)計(jì)3 設(shè)計(jì)約定<說(shuō)明系統(tǒng)設(shè)計(jì)需要遵循的一些約定和約束等。>4 實(shí)現(xiàn)架構(gòu)及功能邏輯4.1 功能邏輯描述<建議分層描述本系統(tǒng)功能模塊，功能模塊可包含面向用戶需求的功能模塊，也可包含面向?qū)崿F(xiàn)的功能模塊（如實(shí)現(xiàn)數(shù)據(jù)庫(kù)的通用訪問(wèn)等），層次建議兩到三層。功能邏輯建議采用功能邏輯圖文字說(shuō)明方式描述，功能邏輯圖建議采用Visio組織機(jī)構(gòu)圖來(lái)畫(huà)，功能模塊描述建議采用分級(jí)標(biāo)題，便于組織和檢索。><樣

4、例：該例子分三個(gè)層次畫(huà)出了三層功能模塊，根據(jù)項(xiàng)目的實(shí)際情況，幾層功能模塊圖可以畫(huà)在一張上圖上。>4.1.1功能模塊結(jié)構(gòu)圖<樣例4.1.1.1頂層功能模塊圖4.1.1.2二層功能模塊圖4.1.1.3三層功能模塊圖>4.1.2功能模塊描述<樣例4.1.2.1組織定義具體描述4.1.2.1.1單位名稱維護(hù)具體描述4.1.2.1.2部門(mén)定義具體描述4.1.2.2流程定義具體描述>4.2 軟件體系架構(gòu)<該章節(jié)主要描述系統(tǒng)的實(shí)現(xiàn)的體系架構(gòu)，以期使讀者從總體上了解項(xiàng)目的設(shè)計(jì)框架。軟件體系架構(gòu)描述包括在物理上，對(duì)象之間通過(guò)函數(shù)或者過(guò)程調(diào)用相互作用；在邏輯上，對(duì)象之間通過(guò)集成

5、、復(fù)合等方式實(shí)現(xiàn)設(shè)計(jì)的復(fù)用。該章節(jié)更多的內(nèi)容面向編碼和實(shí)現(xiàn)，對(duì)于不同的項(xiàng)目或采用不同的工具，設(shè)計(jì)文檔使用的圖示或工具可能不同，如面向?qū)ο蟮脑O(shè)計(jì)可以用高層次的類圖、組件圖、包圖等和相關(guān)文字說(shuō)明等描述整體的體系架構(gòu)，面向過(guò)程的設(shè)計(jì)可能使用高層次的函數(shù)功能分解來(lái)描述，另外該章節(jié)內(nèi)容也包括對(duì)源代碼組成的高層次描述><軟件體系架構(gòu)描述中，另外很重要的是描述系統(tǒng)采用通用或核心的模塊、組件的設(shè)計(jì)思路及實(shí)現(xiàn)框架（如對(duì)數(shù)據(jù)庫(kù)訪問(wèn)的通用實(shí)現(xiàn)）。這些通用設(shè)計(jì)在此處以及在后續(xù)設(shè)計(jì)文檔的集中描述，有利用讀者的理解和閱讀，也有利于設(shè)計(jì)文檔的維護(hù)。><面向編碼和實(shí)現(xiàn)，描述如何組織代碼實(shí)現(xiàn)相關(guān)業(yè)務(wù)邏輯

6、。對(duì)于不同的項(xiàng)目或采用不同的工具，設(shè)計(jì)文檔使用的圖示或工具可能不同，如面向?qū)ο蟮脑O(shè)計(jì)可以用高層次的類圖、組件圖、包圖等和相關(guān)文字說(shuō)明等描述整體的體系架構(gòu)，面向過(guò)程的設(shè)計(jì)可能使用高層次的函數(shù)功能分解來(lái)描述，另外該章節(jié)內(nèi)容也包括對(duì)源代碼組成的高層次描述，建議的章節(jié)結(jié)構(gòu)包括>4.2.1設(shè)計(jì)思路<描述系統(tǒng)總體設(shè)計(jì)采用的框架、工具、方法等，平臺(tái)級(jí)的設(shè)計(jì)思路，以及對(duì)一些難點(diǎn)和復(fù)雜邏輯、權(quán)限等的處理思路><對(duì)于通常的項(xiàng)目，設(shè)計(jì)思路可能包括多個(gè)部分，可以分子章節(jié)描述，如框架、權(quán)限、策略等等>4.2.2包圖及描述<提示：直接通過(guò)數(shù)據(jù)庫(kù)進(jìn)行操作的統(tǒng)計(jì)報(bào)表類系統(tǒng)該部分可以不描述&

7、gt;<主要?jiǎng)?chuàng)建類包圖，通過(guò)層次結(jié)構(gòu)，以在邏輯上組織設(shè)計(jì)，在使用包圖及描述中，要能體現(xiàn)設(shè)計(jì)和功能邏輯間的關(guān)系><一些建議，把一個(gè)框架的所有類放置在相同的包中。一般把相同繼承層次的類放在相同的包中。彼此間有聚合或組合關(guān)系的類通常放在相同的包中。彼此合作頻繁的類，信息能夠通過(guò)UML順序圖和UML合作圖反映出來(lái)的類，通常放在相同的包中。><對(duì)于通常的項(xiàng)目，包圖可能有多個(gè)，可以分子章節(jié)描述><樣例，類包圖示意，缺少描述>4.2.3類圖及描述<提示：直接通過(guò)數(shù)據(jù)庫(kù)進(jìn)行操作的統(tǒng)計(jì)報(bào)表類系統(tǒng)，Sieble套件類系統(tǒng)該部分可以不描述><主要?jiǎng)?chuàng)建

8、類包圖，通過(guò)層次結(jié)構(gòu)，以在邏輯上組織設(shè)計(jì)，在使用類圖及描述中，要能體現(xiàn)設(shè)計(jì)和功能邏輯間的關(guān)系。><此章節(jié)類圖描述系統(tǒng)實(shí)現(xiàn)的高層次主要類以及它們自己的關(guān)系（如繼承、聚合等），并描述出這些類的主要作用，此章節(jié)對(duì)屬性和方法不需要太細(xì)化。><對(duì)于通常的項(xiàng)目，類圖可能有多個(gè)，可以分子章節(jié)描述><樣例，類圖示意，缺少描述>4.2.4主要程序描述<主要適合面向過(guò)程類設(shè)計(jì)或項(xiàng)目中復(fù)雜的邏輯處理，通過(guò)圖釋和說(shuō)明描述項(xiàng)目中主要的函數(shù)功能以及調(diào)用關(guān)系，對(duì)函數(shù)的細(xì)節(jié)不需要太細(xì)化。><對(duì)于通常的項(xiàng)目，主要程序可能有多個(gè)，可以分子章節(jié)描述>4.2.5組件圖

9、及描述<組件圖，目的和“主要程序描述”相同，可以根據(jù)實(shí)際情況選擇使用><樣例，組件圖示意，非面向?qū)ο笤O(shè)計(jì)也可以有組件圖，缺少描述>4.2.6源代碼目錄結(jié)構(gòu)<以樹(shù)型結(jié)構(gòu)并結(jié)合描述描述出系統(tǒng)的較高層次的源代碼目錄結(jié)構(gòu)，以便讀者能很快理解項(xiàng)目程序結(jié)構(gòu)的組織，目錄層次的顆粒度應(yīng)到覆蓋到各需求功能模塊、核心體系架構(gòu)的實(shí)現(xiàn)（基本可以和上面的設(shè)計(jì)文檔描述的層次相當(dāng)。><樣例，僅供參考XXX項(xiàng)目源代碼業(yè)務(wù)功能A登記模塊，并初始化業(yè)務(wù)功能A1業(yè)務(wù)功能B打印組件打印模塊，實(shí)現(xiàn)打印的通用功能圖片庫(kù)>4.2.7權(quán)限設(shè)計(jì)<說(shuō)明該系統(tǒng)在權(quán)限設(shè)計(jì)的總體考慮。>4.

10、3 總體界面設(shè)計(jì)<提示：后臺(tái)接口類的項(xiàng)目該部分可以不寫(xiě)>4.3.1設(shè)計(jì)原則<該項(xiàng)目中界面設(shè)計(jì)的要求、限定等設(shè)計(jì)中要注意的原則>4.3.2設(shè)計(jì)思路<該界面實(shí)現(xiàn)的設(shè)計(jì)思路，如使用XML形成界面菜單，采用CSS提供多套樣式風(fēng)格等>4.3.3界面風(fēng)格<界面的風(fēng)格，如配色、操作等方面的考慮>4.3.4界面層次圖<較高層次的界面的層次圖，如建議和功能邏輯的層次相當(dāng)>4.3.5界面原型<界面草圖或美工設(shè)計(jì)的界面原型，可有主界面級(jí)、視圖級(jí)、表單級(jí)等>5 詳細(xì)設(shè)計(jì)<詳細(xì)設(shè)計(jì)是將“實(shí)現(xiàn)架構(gòu)及功能邏輯”章節(jié)中功能邏輯、體系架構(gòu)的內(nèi)容在實(shí)現(xiàn)

11、上的細(xì)化，以在更深的層次上分解功能邏輯和實(shí)現(xiàn)邏輯，整體的章節(jié)結(jié)構(gòu)隨著功能的細(xì)化可以看作對(duì)“實(shí)現(xiàn)架構(gòu)及功能邏輯”的迭代和細(xì)化，但子模塊的頂級(jí)章節(jié)層次仍采用二級(jí)標(biāo)題層次。對(duì)于該章節(jié)采用的描述工具和方法，“實(shí)現(xiàn)架構(gòu)及功能邏輯”使用的許多工具仍能適用，但該章節(jié)更面向具體的實(shí)現(xiàn)邏輯，根據(jù)不同的項(xiàng)目和使用的工具，可采用如流程圖、順序圖、協(xié)作圖等等來(lái)描述實(shí)現(xiàn)的細(xì)節(jié)。><該章節(jié)的基本面向以編碼為主的項(xiàng)目，對(duì)于許多集成類的項(xiàng)目，如Notes郵件配置、Tivoli單點(diǎn)登錄實(shí)現(xiàn)，也建議按功能模塊來(lái)劃分，參考以下章節(jié)的內(nèi)容，適當(dāng)調(diào)整章節(jié)結(jié)構(gòu)，根據(jù)情況增加一些相關(guān)的圖示和描述，以表達(dá)清楚該功能的實(shí)現(xiàn)設(shè)計(jì)。如

12、Notes的Internet郵件配置，需要描述郵件系統(tǒng)設(shè)計(jì)思路、拓?fù)淇蚣芗跋嚓P(guān)的配置文檔；Tivoli的單點(diǎn)登錄實(shí)現(xiàn)，需要描述每個(gè)相關(guān)系統(tǒng)采用哪種單點(diǎn)登錄模式，應(yīng)用系統(tǒng)和服務(wù)器相應(yīng)的改變、相關(guān)的配置等等。><對(duì)于章節(jié)的細(xì)分，根據(jù)需求分析設(shè)計(jì)的模式可以有不同的方式，如采用功能模塊分解或主題域分解。對(duì)于目前的多數(shù)項(xiàng)目，雖然可能采用面向?qū)ο蟮恼Z(yǔ)言實(shí)現(xiàn)，但我們多數(shù)采用面向過(guò)程的功能分解，一般建議子章節(jié)的結(jié)構(gòu)采用功能邏輯分解。對(duì)于一些業(yè)務(wù)或?qū)崿F(xiàn)上通用的功能及模塊建議單獨(dú)列出，集中描述。><對(duì)于較大的項(xiàng)目，如采用不同模塊采用不同技術(shù)路線開(kāi)發(fā)或功能組織分為幾個(gè)大類，可采用分文檔描述，

13、也可在一個(gè)文檔中描述。如果在一個(gè)文檔中描述，大類的詳細(xì)設(shè)計(jì)可采用一級(jí)標(biāo)題，如5.公文管理詳細(xì)設(shè)計(jì)、6.門(mén)戶詳細(xì)設(shè)計(jì)>5.1 模塊A5.1.1概要說(shuō)明<本模塊的功能簡(jiǎn)述，如有多級(jí)層次，建議分層描述相關(guān)子模塊?？刹捎脠D示或文字說(shuō)明，建議以文字說(shuō)明為主，功能描述可以分子章節(jié)><樣例，簡(jiǎn)單Ø 向內(nèi)核系統(tǒng)登記幾個(gè)proc文件，以便于向內(nèi)核空間中查詢安全聯(lián)盟和eoute表，以及虛接口的狀況；Ø 初始化SA數(shù)據(jù)庫(kù)（tdb鏈）；Ø 初始化SPDB數(shù)據(jù)庫(kù)（eroute表）；Ø 初始化pf_key（PF_KEY套接口）；><樣例，子章節(jié)組

14、織定義：具體描述單位名稱維護(hù)：具體描述部門(mén)定義：具體描述流程定義：具體描述>5.2.2實(shí)現(xiàn)框架<以下的章節(jié)結(jié)構(gòu)目的是從不同的維度和視圖來(lái)描述設(shè)計(jì)，供參考。實(shí)際項(xiàng)目中可進(jìn)行擴(kuò)展和裁剪，建議大家學(xué)習(xí)UML的各種圖示，統(tǒng)一采用UML圖示來(lái)表達(dá)設(shè)計(jì)方面的各種視圖>設(shè)計(jì)思路：<描述該總體設(shè)計(jì)采用的框架、工具、方法等，以及對(duì)一些難點(diǎn)和復(fù)雜邏輯的處理思路><對(duì)于通常的項(xiàng)目，設(shè)計(jì)思路可能包括多個(gè)部分，可以分子章節(jié)描述>包圖及描述：<提示：數(shù)據(jù)庫(kù)操作類的項(xiàng)目該部分可以不描述><該類包圖，通過(guò)層次結(jié)構(gòu)，以在邏輯上組織設(shè)計(jì)，在使用包圖及描述中，要能體現(xiàn)設(shè)計(jì)

15、和功能邏輯間的關(guān)系>類圖及描述：<提示：數(shù)據(jù)庫(kù)操作類的項(xiàng)目，Sieble套件類系統(tǒng)該部分可以不描述><該模塊的類圖，通過(guò)層次結(jié)構(gòu)，以在邏輯上組織設(shè)計(jì)，在使用類圖及描述中，要能體現(xiàn)設(shè)計(jì)和功能邏輯間的關(guān)系，同“實(shí)現(xiàn)架構(gòu)及功能邏輯”章節(jié)不同，該章節(jié)將深入描述類實(shí)現(xiàn)的細(xì)節(jié)，如方法、屬性等等。如果該模塊比較復(fù)雜，可以分子章節(jié)來(lái)描述，并在子章節(jié)中細(xì)化設(shè)計(jì)>設(shè)計(jì)的文件清單結(jié)構(gòu)<以樹(shù)型結(jié)構(gòu)并結(jié)合描述描述出系統(tǒng)的較高層次的源代碼目錄及文件結(jié)構(gòu)，以便讀者能很快理解模塊程序結(jié)構(gòu)的組織，顆粒度應(yīng)到覆蓋到主要的代碼。><樣例，僅供參考XXX模塊源代碼業(yè)務(wù)功能A登記模塊，并

16、初始化業(yè)務(wù)功能A1業(yè)務(wù)功能B打印組件打印模塊，實(shí)現(xiàn)打印的通用功能圖片庫(kù)>5.3.3主要邏輯實(shí)現(xiàn)描述：<描述邏輯功能的實(shí)現(xiàn)，包括類方法或函數(shù)實(shí)現(xiàn)。此章節(jié)的內(nèi)容可能是設(shè)計(jì)的重點(diǎn)，對(duì)于不同的實(shí)現(xiàn)，可采用不同方式描述。如使用UML圖示中的合作圖、活動(dòng)圖進(jìn)行動(dòng)態(tài)建模。但對(duì)于過(guò)程的細(xì)節(jié)描述仍建議采用傳統(tǒng)的方式，描述程序?qū)崿F(xiàn)的數(shù)據(jù)結(jié)構(gòu)、算法和流程邏輯。對(duì)于此章節(jié)的組織，需要從實(shí)現(xiàn)的業(yè)務(wù)邏輯入手，而不要突然跳出一個(gè)圖來(lái)，章節(jié)要有整體感。><樣例1，順序圖>賬戶間轉(zhuǎn)帳順序圖：文字描述<樣例2，典型的過(guò)程設(shè)計(jì)文檔>登記及初始化變量說(shuō)明1) device結(jié)構(gòu)static s

17、truct device dev_ipsec0 = "ipsec00 ", /* name */ NULL,/* next device */ ipsec_tunnel_probe /* setup */;2) 數(shù)據(jù)結(jié)構(gòu)2.3) 函數(shù)說(shuō)明1) void call_server(void)<功能：說(shuō)明該程序應(yīng)具有的功能，可采用IPO圖（即輸入一處理一輸出圖）的形式。>功能：監(jiān)聽(tīng)SA協(xié)商消息IKE消息、whack消息和pfkey消息，收到上述幾種消息后，再調(diào)用相應(yīng)處理模塊。<性能：說(shuō)明對(duì)該程序的全部性能要求，包括對(duì)精度、靈活性和時(shí)間特性的要求。>性能：無(wú)

18、<輸入項(xiàng)：給出對(duì)每一個(gè)輸入項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。 數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來(lái)源和安全保密條件等等。>輸入項(xiàng)：無(wú)<輸出項(xiàng)，給出對(duì)每一個(gè)輸出項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸出的形式、數(shù)量和頻度，輸出媒體、對(duì)輸出圖形及符號(hào)的說(shuō)明、安全保密條件等等。>輸出項(xiàng)：無(wú)<算法，詳細(xì)說(shuō)明本程序所選用的算法或流程，包括具體的計(jì)算公式和計(jì)算步驟，可用圖表（例如流程圖、判定表等）輔以必要的說(shuō)明來(lái)表示本程序的邏輯流程，也可以用偽代碼來(lái)表示流程邏輯>算法： 1調(diào)用函數(shù)init_pfkeyed()，創(chuàng)建PF_KEY類型的套接口； 2調(diào)用函數(shù)init_whackfd()，創(chuàng)建AF_UNIX型套接口，用于通信； 2進(jìn)入循環(huán)等待，接收到來(lái)的消息： 如果收到IKE協(xié)商消息，調(diào)用函數(shù)comm_handle()處理； 如果收到whack消息，調(diào)用函數(shù)whack_handle()處理； 如果收到pfkey消息，調(diào)用函數(shù)pfkey_handle()處理。2) 函數(shù)2.5.3.4界面設(shè)計(jì)<說(shuō)明該模塊的界面的設(shè)計(jì)思路和設(shè)計(jì)元素。設(shè)計(jì)思路包括界面草圖、界面層次，界面風(fēng)格等。若無(wú)或在其它文檔描述，可略>界面層次圖界面