1、密級：機密文檔編號：XXX_TS_TEMP_XXSJSMS版本號：V2.0【項目名稱】詳細設計說明書模板編寫人：XXX批準人：XXX生效日期：2017年1月6日版權信息本文件涉及之信息，屬 XXX所有。未經(jīng)XXX允許，文件中的任何部分都不能以任何形式向第三方散發(fā)。文檔修訂記錄版本號修訂日期修訂人修訂說明修訂狀態(tài)審核日期審核人批準人V0.12016-12-1XXX創(chuàng)建A2016-12-1XXXXXXV1.02016-12-28XXX調整需求分析方法M2016-12-29XXXXXXV2.02017-1-4XXX更換使用模板M2017-1-6XXXXXX修訂狀態(tài)：A-增加，M-修改，D-刪除日期格

2、式：YYYY-MM-DD目錄1 概述 11.1 編寫目的 11.2 適用范圍 11.3 術語和縮寫 11.4 參考資料 12 角色和職責 13 設計約定 24 實現(xiàn)架構及功能邏輯 24.1 功能邏輯描述 24.1.1 功能模塊結構圖 24.1.2 功能模塊描述 34.2 軟件體系架構 34.2.1 設計思路 44.2.2 包圖及描述 44.2.3 類圖及描述 64.2.4 主要程序描述 74.2.5 組件圖及描述 74.2.6 源代碼目錄結構 74.2.7 權限設計 84.3 總體界面設計 84.3.1 設計原則 84.3.2 設計思路 84.3.3 界面風格 84.3.4 界面層次圖 94.

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

4、指出為完成本文檔所需要的參考資料，包括a屬于本項目的其它已發(fā)表的文件；b本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標準。列出這些文件的標題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。參考文件備注XXXX項目需求規(guī)格說明書XXXX項目系統(tǒng)概要設計報告2 角色和職責角色職責項目經(jīng)理指導和審查數(shù)據(jù)庫的詳細設計系統(tǒng)分析員負責數(shù)據(jù)庫的詳細設計3 設計約定說明系統(tǒng)設計需要遵循的一些約定和約束等。4 實現(xiàn)架構及功能邏輯4.1 功能邏輯描述建議分層描述本系統(tǒng)功能模塊，功能模塊可包含面向用戶需求的功能模塊，也可包含面向實現(xiàn)的功能模塊（如實現(xiàn)數(shù)據(jù)庫的通用訪問等），層次建議兩到三層。功能邏

5、輯建議采用功能邏輯圖+文字說明方式描述，功能邏輯圖建議采用 Visio組織機構圖來畫，功能模塊描述建議采用分級標題，便于組織和檢索。樣例：該例子分三個層次畫出了三層功能模塊，根據(jù)項目的實際情況，幾層功能模塊圖可以畫在一張上圖上。功能模塊結構圖樣例頂層功能模塊圖二層功能模塊圖三層功能模塊圖>功能模塊描述<樣例組織定義具體描述4.1.2.1.1 單位名稱維護具體描述4.1.2.1.2 部門定義具體描述流程定義具體描述>4.2 軟件體系架構<該章節(jié)主要描述系統(tǒng)的實現(xiàn)的體系架構，以期使讀者從總體上了解項目的設計框架。軟件體系架構描述包括在物理上，對象之間通過函數(shù)或者過程調用相互

6、作用；在邏輯上，對象之間通過集成、復合等方式實現(xiàn)設計的復用。該章節(jié)更多的內容面向編碼和實現(xiàn)，對于不 同的項目或采用不同的工具， 設計文檔使用的圖示或工具可能不同， 如面向對象的設計可以 用高層次的類圖、 組件圖、 包圖等和相關文字說明等描述整體的體系架構， 面向過程的設計 可能使用高層次的函數(shù)功能分解來描述，另外該章節(jié)內容也包括對源代碼組成的高層次描 述><軟件體系架構描述中，另外很重要的是描述系統(tǒng)采用通用或核心的模塊、組件的設計 思路及實現(xiàn)框架（如對數(shù)據(jù)庫訪問的通用實現(xiàn)） 。這些通用設計在此處以及在后續(xù)設計文檔 的集中描述，有利用讀者的理解和閱讀，也有利于設計文檔的維護。 >

7、;< 面向編碼和實現(xiàn)，描述如何組織代碼實現(xiàn)相關業(yè)務邏輯。對于不同的項目或采用不同 的工具， 設計文檔使用的圖示或工具可能不同， 如面向對象的設計可以用高層次的類圖、 組 件圖、 包圖等和相關文字說明等描述整體的體系架構， 面向過程的設計可能使用高層次的函 數(shù)功能分解來描述， 另外該章節(jié)內容也包括對源代碼組成的高層次描述， 建議的章節(jié)結構包 括>4.2.1 設計思路< 描述系統(tǒng)總體設計采用的框架、工具、方法等，平臺級的設計思路，以及對一些難點 和復雜邏輯、權限等的處理思路 >< 對于通常的項目，設計思路可能包括多個部分，可以分子章節(jié)描述，如框架、權限、 策略等等 &

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

9、通過數(shù)據(jù)庫進行操作的統(tǒng)計報表類系統(tǒng)，Sieble套件類系統(tǒng)該部分可以不描述主要創(chuàng)建類包圖，通過層次結構，以在邏輯上組織設計，在使用類圖及描述中，要能 體現(xiàn)設計和功能邏輯間的關系。此章節(jié)類圖描述系統(tǒng)實現(xiàn)的高層次主要類以及它們自己的關系（如繼承、聚合等） 并描述出這些類的主要作用，此章節(jié)對屬性和方法不需要太細化。對于通常的項目，類圖可能有多個，可以分子章節(jié)描述樣例，類圖示意，缺少描述 '<Euj in«-sObject>It»-:d : iLt=?er'Buz ins-53ObRCt >Title"卜嚴丁三卄-T.nmp - Sr i

10、ns-/mi ±十 丫1.二£ ah t:tl含：“* fitkd g id(f fiod an f宜tioa f) treaTe ：Jil&stror ij置 inti 廠| cnate ieji ror'至77T弓E-in»OhjMrt *>Book Tltlicfat') -srtroy-<BU51Hr£SQbj«t >Etorrmraddress z :七ric壬CT4ST0 0 ieitrsy'/-JuzmEcfiMaeuIm Tit Ltcreated d*stroF(?O-<

11、 吐ELZli丄REeimtinn-cEite : Eae = 當甫日朝treats；) iesTr-1U.5F rt.Grrvrc.-11 a Vn-424主要程序描述主要適合面向過程類設計或項目中復雜的邏輯處理，通過圖釋和說明描述項目中主要的函數(shù)功能以及調用關系，對函數(shù)的細節(jié)不需要太細化。對于通常的項目，主要程序可能有多個，可以分子章節(jié)描述組件圖及描述組件圖，目的和“主要程序描述”相同，可以根據(jù)實際情況選擇使用樣例，組件圖示意，非面向對象設計也可以有組件圖，缺少描述源代碼目錄結構以樹型結構并結合描述描述出系統(tǒng)的較咼層次的源代碼目錄結構，以便讀者能很快理解項目程序結構的組織，目錄層次的顆粒度

12、應到覆蓋到各需求功能模塊、核心體系架構的實現(xiàn)（基本可以和上面的設計文檔描述的層次相當。 >< 樣例，僅供參考XXX 項目源代碼業(yè)務功能 A 登記模塊，并初始化業(yè)務功能 A1業(yè)務功能 B打印組件 打印模塊，實現(xiàn)打印的通用功能 圖片庫>權限設計< 說明該系統(tǒng)在權限設計的總體考慮。 >4.3 總體界面設計< 提示：后臺接口類的項目該部分可以不寫 >4.3.1 設計原則< 該項目中界面設計的要求、限定等設計中要注意的原則>4.3.2 設計思路< 該界面實現(xiàn)的設計思路， 如使用 XML 形成界面菜單， 采用 CSS 提供多套樣式風格等 >

13、4.3.3 界面風格< 界面的風格，如配色、操作等方面的考慮 >4.3.4 界面層次圖< 較高層次的界面的層次圖，如建議和功能邏輯的層次相當 >4.3.5 界面原型< 界面草圖或美工設計的界面原型，可有主界面級、視圖級、表單級等 >5 詳細設計<詳細設計是將“實現(xiàn)架構及功能邏輯”章節(jié)中功能邏輯、體系架構的內容在實現(xiàn)上的細化， 以在更深的層次上分解功能邏輯和實現(xiàn)邏輯， 整體的章節(jié)結構隨著功能的細化可以看 作對“實現(xiàn)架構及功能邏輯” 的迭代和細化， 但子模塊的頂級章節(jié)層次仍采用二級標題層次。 對于該章節(jié)采用的描述工具和方法， “實現(xiàn)架構及功能邏輯”使用的許

14、多工具仍能適用，但 該章節(jié)更面向具體的實現(xiàn)邏輯，根據(jù)不同的項目和使用的工具，可采用如流程圖、順序圖、 協(xié)作圖等等來描述實現(xiàn)的細節(jié)。 >< 該章節(jié)的基本面向以編碼為主的項目，對于許多集成類的項目，如 Notes 郵件配置、 Tivoli 單點登錄實現(xiàn)， 也建議按功能模塊來劃分， 參考以下章節(jié)的內容， 適當調整章節(jié)結構， 根據(jù)情況增加一些相關的圖示和描述， 以表達清楚該功能的實現(xiàn)設計。 如 Notes 的 Internet 郵件配置，需要描述郵件系統(tǒng)設計思路、拓撲框架及相關的配置文檔； Tivoli 的單點登錄實 現(xiàn)， 需要描述每個相關系統(tǒng)采用哪種單點登錄模式，應用系統(tǒng)和服務器相應的改

15、變、 相關的配置等等。 ><對于章節(jié)的細分，根據(jù)需求分析設計的模式可以有不同的方式，如采用功能模塊分解 或主題域分解。 對于目前的多數(shù)項目， 雖然可能采用面向對象的語言實現(xiàn)， 但我們多數(shù)采用 面向過程的功能分解， 一般建議子章節(jié)的結構采用功能邏輯分解。 對于一些業(yè)務或實現(xiàn)上通 用的功能及模塊建議單獨列出，集中描述。 >< 對于較大的項目，如采用不同模塊采用不同技術路線開發(fā)或功能組織分為幾個大類，可采用分文檔描述， 也可在一個文檔中描述。 如果在一個文檔中描述， 大類的詳細設計可采 用一級標題，如 5. 公文管理詳細設計、 6. 門戶詳細設計 >5.1 模塊 A5.

16、1.1 概要說明<本模塊的功能簡述，如有多級層次，建議分層描述相關子模塊?？刹捎脠D示或文字說 明，建議以文字說明為主，功能描述可以分子章節(jié) >< 樣例，簡單? 向內核系統(tǒng)登記幾個 proc 文件， 以便于向內核空間中查詢安全聯(lián)盟和 eoute 表，以及虛接口的狀況；? 初始化 SA 數(shù)據(jù)庫（ tdb 鏈）；? 初始化 SPDB 數(shù)據(jù)庫（ eroute 表）；? 初始化 pf_key （ PF_KEY 套接口）；>< 樣例，子章節(jié)組織定義：具體描述單位名稱維護：具體描述 部門定義：具體描述流程定義：具體描述 >5.2.2 實現(xiàn)框架< 以下的章節(jié)結構目的是

17、從不同的維度和視圖來描述設計，供參考。實際項目中可進行 擴展和裁剪，建議大家學習 UML 的各種圖示，統(tǒng)一采用 UML 圖示來表達設計方面的各種 視圖 >設計思路：< 描述該總體設計采用的框架、 工具、方法等， 以及對一些難點和復雜邏輯的處理思路 >< 對于通常的項目，設計思路可能包括多個部分，可以分子章節(jié)描述>包圖及描述：< 提示：數(shù)據(jù)庫操作類的項目該部分可以不描述 >< 該類包圖，通過層次結構，以在邏輯上組織設計，在使用包圖及描述中，要能體現(xiàn)設 計和功能邏輯間的關系 >類圖及描述：< 提示：數(shù)據(jù)庫操作類的項目， Sieble 套件

18、類系統(tǒng)該部分可以不描述 ><該模塊的類圖，通過層次結構，以在邏輯上組織設計，在使用類圖及描述中，要能體 現(xiàn)設計和功能邏輯間的關系，同“實現(xiàn)架構及功能邏輯”章節(jié)不同，該章節(jié)將深入描述類實 現(xiàn)的細節(jié)，如方法、屬性等等。如果該模塊比較復雜，可以分子章節(jié)來描述，并在子章節(jié)中 細化設計 >設計的文件清單結構< 以樹型結構并結合描述描述出系統(tǒng)的較高層次的源代碼目錄及文件結構， 以便讀者能 很快理解模塊程序結構的組織，顆粒度應到覆蓋到主要的代碼。 >< 樣例，僅供參考XXX 模塊源代碼業(yè)務功能 A 登記模塊，并初始化業(yè)務功能 A1業(yè)務功能 B打印組件 打印模塊，實現(xiàn)打印的

19、通用功能圖片庫>5.3.3 主要邏輯實現(xiàn)描述：< 描述邏輯功能的實現(xiàn)，包括類方法或函數(shù)實現(xiàn)。此章節(jié)的內容可能是設計的重點，對 于不同的實現(xiàn)， 可采用不同方式描述。 如使用 UML 圖示中的合作圖、 活動圖進行動態(tài)建模。 但對于過程的細節(jié)描述仍建議采用傳統(tǒng)的方式， 描述程序實現(xiàn)的數(shù)據(jù)結構、 算法和流程邏輯。 對于此章節(jié)的組織， 需要從實現(xiàn)的業(yè)務邏輯入手， 而不要突然跳出一個圖來， 章節(jié)要有整體感。樣例1，順序圖賬戶間轉帳順序圖：Fmtnc miTranMctmManagerRecord Iransadicn .irtrjsenc I- (ratisjctriLiaaeirTprwtt

20、riilrayfaiCBrnciurLiJiw 門 sscuonliyi3 dthdr.3；3incurTi. 5wrcc, tr?n sadtpnip) dlertptDep-i&iifaiiiiounr, tr sns air nlD) .'emor訐衛(wèi)>：15山習口1£|亍1帀IjMinlL qi imnilftan- dEtion D)文字描述樣例2，典型的過程設計文檔 登記及初始化變量說明1) device 結構static struct device dev_ipsecO =EXirnnriHiTm門訶戍cinJIDTmmiti'trnsic

21、rDniD)<meiude»"ipsec00 ", /* name */ NULL, /* next device */ ipsec_tunnel_probe /* setup */;2) 數(shù)據(jù)結構 2.3)函數(shù)說明1) void call_server(void)< 功能：說明該程序應具有的功能， 可采用 IPO 圖(即輸入一處理一輸出圖) 的形式。 >功能：監(jiān)聽SA協(xié)商消息IKE消息、whack消息和pfkey消息，收到上述幾種消息后，再調用相應處理模塊。< 性能：說明對該程序的全部性能要求，包括對精度、靈活性和時間特性的要求。>性能：無< 輸入項：給出對每一個輸入項的特性，包括名稱、標識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、 輸入的方式。 數(shù)量和頻度、 輸入媒體、 輸入數(shù)據(jù)的來源和安全保密條件等等。 >輸入項：無< 輸出項，給出對每一個輸出項的特性，包括名稱、標識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值 的有效范圍，輸出的形式、數(shù)量和頻度，輸出媒體、對輸出圖形及符號的說明、安全保密條 件等等。輸出項：無<算法，