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

1、精品密級(jí)：機(jī)密文檔編號(hào)：XXX_TS_TEMP_XXSJSMS版本號(hào)：V2.0【項(xiàng)目名稱】詳細(xì)設(shè)計(jì)說(shuō)明書模板編寫人：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-增加，M-修改，

2、D-刪除日期格式：YYYY-MM-DD目錄1 概述 11.1 編寫目的 11.2 適用范圍 11.3 術(shù)語(yǔ)和縮寫 11.4 參考資料 12 角色和職責(zé) 13 設(shè)計(jì)約定 24 實(shí)現(xiàn)架構(gòu)及功能邏輯 24.1 功能邏輯描述 24.1.1 功能模塊結(jié)構(gòu)圖 24.1.2 功能模塊描述 34.2 軟件體系架構(gòu) 34.2.1 設(shè)計(jì)思路 44.2.2 包圖及描述 44.2.3 類圖及描述 64.2.4 主要程序描述 74.2.5 組件圖及描述 74.2.6 源代碼目錄結(jié)構(gòu) 74.2.7 權(quán)限設(shè)計(jì) 84.3 總體界面設(shè)計(jì) 84.3.1 設(shè)計(jì)原則 84.3.2 設(shè)計(jì)思路 84.3.3 界面風(fēng)格 84.3.4 界面

3、層次圖 94.3.5 界面原型 95 詳細(xì)設(shè)計(jì) 95.1 模塊 A1.05.1.1 概要說(shuō)明 1.05.2.2 實(shí)現(xiàn)框架 1.15.3.3 主要邏輯實(shí)現(xiàn)描述： 1.25.3.4 界面設(shè)計(jì) 1.55.3.5 接口設(shè)計(jì) 1.65.3.6 其它 1.65.2 模塊 B1.66 數(shù)據(jù)庫(kù)設(shè)計(jì) 1.6.7 接口設(shè)計(jì) 1.68 附錄： 1.6.1 概述1.1 編寫目的此處填寫本文檔的目的 例如：XXX項(xiàng)目的目的是：根據(jù)XXX需求規(guī)格說(shuō)明書進(jìn)行詳細(xì)設(shè)計(jì) 1.2 適用范圍此處填寫本文檔的適用范圍等 1.3 術(shù)語(yǔ)和縮寫此處填寫本文檔中所特有的術(shù)語(yǔ)和縮寫，常用的術(shù)語(yǔ)和縮寫統(tǒng)一編寫在一個(gè)規(guī)范文檔中術(shù)語(yǔ)和縮寫解釋備注1

4、.4 參考資料指出為完成本文檔所需要的參考資料，包括a屬于本項(xiàng)目的其它已發(fā)表的文件；b本文件中各處引用到的文件資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件的來(lái)源。參考文件備注XXXX項(xiàng)目需求規(guī)格說(shuō)明書XXXX項(xiàng)目系統(tǒng)概要設(shè)計(jì)報(bào)告2 角色和職責(zé)角色職責(zé)項(xiàng)目經(jīng)理指導(dǎo)和審查數(shù)據(jù)庫(kù)的詳細(xì)設(shè)計(jì)系統(tǒng)分析員負(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)等），層次建議兩

5、到三層。功能邏輯建議采用功能邏輯圖+文字說(shuō)明方式描述，功能邏輯圖建議采用 Visio組織機(jī)構(gòu)圖來(lái)畫，功能模塊描述建議采用分級(jí)標(biāo)題，便于組織和檢索。樣例：該例子分三個(gè)層次畫出了三層功能模塊，根據(jù)項(xiàng)目的實(shí)際情況，幾層功能模塊圖可以畫在一張上圖上。4.1.1功能模塊結(jié)構(gòu)圖樣例4.1.1.1頂層功能模塊圖4.1.1.2二層功能模塊圖4.1.1.3三層功能模塊圖4.1.2功能模塊描述4.2 軟件體系架構(gòu)4.2.1 設(shè)計(jì)思路4.2.2 包圖及描述423類圖及描述提示：直接通過(guò)數(shù)據(jù)庫(kù)進(jìn)行操作的統(tǒng)計(jì)報(bào)表類系統(tǒng)，Sieble套件類系統(tǒng)該部分可以不描述主要?jiǎng)?chuàng)建類包圖，通過(guò)層次結(jié)構(gòu)，以在邏輯上組織設(shè)計(jì)，在使用類圖及

6、描述中，要能 體現(xiàn)設(shè)計(jì)和功能邏輯間的關(guān)系。此章節(jié)類圖描述系統(tǒng)實(shí)現(xiàn)的高層次主要類以及它們自己的關(guān)系（如繼承、聚合等） 并描述出這些類的主要作用，此章節(jié)對(duì)屬性和方法不需要太細(xì)化。對(duì)于通常的項(xiàng)目，類圖可能有多個(gè)，可以分子章節(jié)描述樣例，類圖示意，缺少描述 It-:d : iLt=?erBuz ins-53ObRCt Title卜嚴(yán)丁三卄-T.nmp - Sr ins-/mi 十 丫1.二 ah t:tl含：“* fitkd g id(f fiod an f宜tioa f) treaTe ：Jil&stror ij置 inti 廠| cnate ieji ror至77T弓E-inOhjMrt *Book

7、 Tltlicfat) -srtroy- Etorrmraddress z :七ric壬CT4ST0 0 ieitrsy/-JuzmEcfiMaeuIm Tit Ltcreated d*stroF(?O-4.2.7 權(quán)限設(shè)計(jì)4.3 總體界面設(shè)計(jì)4.3.1 設(shè)計(jì)原則4.3.2 設(shè)計(jì)思路4.3.3 界面風(fēng)格4.3.4 界面層次圖4.3.5 界面原型5 詳細(xì)設(shè)計(jì)5.1 模塊 A5.1.1 概要說(shuō)明5.2.2 實(shí)現(xiàn)框架設(shè)計(jì)思路：包圖及描述：類圖及描述：設(shè)計(jì)的文件清單結(jié)構(gòu)5.3.3 主要邏輯實(shí)現(xiàn)描述：15山習(xí)口1|亍1帀IjMinlL qi imnilftan- dEtion D)文字描述樣例2，典型的

8、過(guò)程設(shè)計(jì)文檔 登記及初始化變量說(shuō)明1) device 結(jié)構(gòu)static struct device dev_ipsecO =EXirnnriHiTm門訶戍cinJIDTmmititrnsicrDniD)meiudeipsec00 , /* name */ NULL, /* next device */ ipsec_tunnel_probe /* setup */;2) 數(shù)據(jù)結(jié)構(gòu) 2.3)函數(shù)說(shuō)明1) void call_server(void)功能：監(jiān)聽(tīng)SA協(xié)商消息IKE消息、whack消息和pfkey消息，收到上述幾種消息后，再調(diào)用相應(yīng)處理模塊。性能：無(wú)輸入項(xiàng)：無(wú) 輸出項(xiàng)，給出對(duì)每一個(gè)輸出項(xiàng)的特性，包括名稱、標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值 的有效范圍，輸出的形式、數(shù)量和頻度，輸出媒體、對(duì)輸出圖形及符號(hào)的說(shuō)明、安全保密條 件等等。輸出項(xiàng)：無(wú)算法：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_