1、XXX項目系統設計說明書（文檔編號:項目經理:生效日期:1.編制目的 . 錯誤！未定義書簽。2.適用范圍 . 錯誤！未定義書簽。3.文件說明 . 錯誤！未定義書簽。1.概述.41.1系統簡介.41.2系統目標 .41.3系統設計原則.41.4系統運行環境.41.5開發環境.42.總 體 結 構.42.1系統部署 .42.1.12.1.1系統拓撲結構.4 42.1.22.1.2系統部署說明.5 52.2軟件部署.53.數據流程.53.1數據流程圖.53.2數據流程圖說明 .53.3數據字典.54.系統模塊設計.54.1子系統模塊結構圖 .54.2子系統模塊概要設計 .55.數據庫設計.65.1結

2、構概要.65.2表結構.66.接口設計.76.1人機界面設計.76.2軟件接口設計.76.3外部軟件接口 .86.4外部硬件接口 .87.數據設計.87.1全局數據.87.2文件組織結構.87.3文件結構.97.4數據備份、恢復 .98.系統業務功能設計 .98.1業務內容.98.2處理流程.99.其它設計.910.代碼組織.910.1源代碼組織結構 .910.2編譯方式.910.3源代碼文件說明 .911.術語表.10設備，均應以圖形方式加以描述。1.1.概述 1.11.1 系統簡介簡要描述本系統基本情況。1.21.2 系統目標描述概要設計所要實現的目標，包括功能目標、性能目標等。1.31.

3、3 系統設計原則列舉系統設計時遵循的基本理論或基本原則，例如面向對象的系統分析原則、逐步求精原則等。根據用戶需求和系統設計原則，對設計要點進行優先級排序（注：一定要分出優先次序，不能有任何兩項平級），要點可包括：體積大小、速度、可靠性、安全性、易測試性、易維護性、可復用性、可移植性等。1.41.4 系統運行環境包括對硬件平臺、操作系統、數據庫系統、中間件平臺、編程平臺、網絡和外圍設備、網絡傳輸介質和網絡協議的描述。對于 B/SB/S 或 C/SC/S 結構需要分別指出各部分的運行環境。1.51.5 開發環境列舉項目組進行系統分析、程序設計和程序開發時用到的工程工具和開發語言。應描述每一工具軟件

4、的名稱、版本等。2.2.總體結構2.12.1 系統部署2.1.12.1.1 系統拓撲結構圖以圖形方式給出該軟件產品在用戶方部署時，預期的網絡和硬件部署結構，以及系統和其他系統間的部署關系等。涉及網絡結構時，建議使用網絡拓撲圖方式描述。對軟件運行時需要配置的計算機或其他外部2.1.22.1.2 系統部署說明對上面的系統部署圖中每個系統設備的功能加以必要的描述，說明該設備的基本配置要求，其 上運行的操作系統名稱和版本，應用程序的名稱和版本等。2.22.2 軟件部署描述應用軟件體系部署，可以包括設計思想、部署圖、軟件架構說明、層次結構等方面。3.3. 數據流程3.13.1 數據流程圖以圖形方式描述系

5、統整體的數據流轉情況及數據處理行為，數據流程圖格式應符合軟件工程的 一般標準。3.23.2 數據流程圖說明對上面的數據流程圖中每個數據流轉或數據處理環節加以必要的解釋和說明。3.33.3 數據字典4.4. 系統模塊設計4.14.1 子系統模塊結構圖以圖形方式給出軟件系統的子系統（或軟件包）劃分，模塊劃分，子系統間、模塊間關系等。結構圖格式應符合軟件工程的一般標準。（注意：一般應在系統結構中包含“發布子系統”，即通常所說的安裝程序或其他形式的發布程序，在下面的“子系統模塊概要設計”中也應包含“發布子系統”的概要設計說明。）4.24.2 子系統模塊概要設計對“子系統模塊結構圖”中出現的每個子系統或

6、模塊，描述以下內容：名稱和版本。子系統或模塊的內部編號（編號格式由項目組自定）。表現形式（以何種形式運行，如服務程序、應用程序、COMCOM 組件、數據庫腳本、JSPJSP 程序等等）。功能描述。處理流程圖（對較簡單的模塊，在前面“功能描述”中已可以準確定義該模塊功能的，可省略功能流程圖）子系統模塊有無人機交互界面，如有，則給出該子系統-模塊人機交互界面的類型（如普通WebWeb 界面、普通 GUIGUI 界面、JavaJava AppletApplet 界面、JavaJava SwingSwing 界面、字符終端界面、命令行界面等）和設計原則（界面風格、基本操作方式等）。與其他子系統或模塊的

7、接口（描述每個接口的名稱、輸入信息、輸出信息、異常處理等）實現方式（以何種開發工具，何種開發語言實現該子系統或模塊）。實現思路（給出實現該模塊的基本思路，包括對模塊內部結構、算法、編程方法等的初步 設想）。5.5.數據庫設計此節描述存儲在通用數據庫中的數據，或存儲在硬盤、磁帶、光盤等永久性存儲介質上，但存 儲格式與通用數據庫相同的數據。如果系統不以數據庫方式存儲數據，則此節可省略。5.15.1 結構概要描述數據庫的系統設置、表空間分配、用戶權限設置等概要信息。5.25.2 表結構必要時，可用單獨的文檔（如， XXXXXX 數據庫結構設計）來描述數據庫設計。對不需要單獨的文檔來描述數據庫設計的，

8、對系統使用的每一種數據庫表或數據庫視圖，參考 下面的表格，描述其內部結構：表或視圖名稱字段數該表在系統中的功能簡述所屬表空間或數據文件名稱字段名稱字段類型字段長度和精度主、夕卜鍵關系字段說明字段取值范圍 或約束關系字段的缺省值創建該表的 SQLSQL 語句:6.6.接口設計6.16.1 人機界面設計對于系統中涉及人機交互界面的模塊，從以下幾方面內容進行描述：界面類型（如普通 WebWeb 界面、普通 GUIGUI 界面、JavaJava AppletApplet 界面、JavaJava SwingSwing 界面、字符終端界面、命令行界面等）界面圖示。以圖形方式給出界面外觀，圖形中應能清晰表現

9、界面風格（顏色、字體、排版、樣式等），界面要素個數，界面要素位置，界面要素的名稱和顯示文本內容，界面的修飾圖案等。菜單和工具欄描述。對有菜單和工具欄的界面，以文字或圖形方式給出界面中的菜單和工具欄結構，包括其中每個菜單項或工具欄項目的名稱、類型、對應的處理功能等。界面的輸入數據項目。描述用戶在該界面上輸入的數據名稱、類型、格式、相關的界面要素名稱等。界面的輸出數據項目。描述系統在該界面上輸出的數據名稱、類型、格式、相關的界面要素名稱等。界面響應的用戶事件。以文本或圖表方式列舉界面響應的每種用戶事件（例如鼠標點擊、鼠標拖曳、熱鍵等，但菜單和工具欄事件除外）的類型、名稱、引發的處理動作等內容。如該

10、界面具有聯機幫助系統，則描述聯機幫助系統的實現方式（如 TooltipTooltip 幫助、界面中的文本信息、文本文件、HTMLHTML 文件、*.doc*.doc 文件、*.hlp*.hlp 幫助文件、*.chm*.chm 幫助文件等），概述其幫助信息內容，并注明幫助信息所在的原始文件名稱。其他需要描述的界面設計內容。6.26.2 軟件接口設計對模塊提供的與其他模塊或其他系統交互的軟件接口，描述以下內容：接口名稱，版本。接口類型。接口表現形式（函數調用、遠程交易、信號響應等）。接口的輸入項目。接口的輸出項目。接口完成的處理功能。接口的異常處理設計。其他需要描述的接口設計內容。6.36.3 外

11、部軟件接口對模塊使用到的其他模塊或其他系統的軟件接口，列舉以下內容：1.1.接口所屬的軟件或模塊名稱。2.2.接口名稱。3.3.接口的描述文檔（一般為“參見 XXXX 模塊詳細設計說明書）。無參照文檔的，在此給出 接口的功能、輸入、輸出描述。6.46.4 外部硬件接口對模塊使用到的硬件接口，在此給出該接口的規格描述（硬件名稱、連接方法、電氣特性等）或注明“參見XXXX”文件說明。7.7.數據設計7.17.1 全局數據針對系統中使用的全局數據，包括變量和常量，描述以下內容：1.1.變量或常量名稱。2.2.變量或常量類型。3.3.變量或常量字節大小和內部結構。4.4.變量或常量的用途。5.5.其他

12、需要描述的信息。7.27.2 文件組織結構指文件在存儲介質上的目錄層次、目錄命名、文件類型、文件命名等內容。7.37.3 文件結構精確描述每種數據文件的內部結構。此項內容無特定格式要求。7.47.4 數據備份、恢復描述系統數據備份、恢復的方式、方法。8.8. 系統業務功能設計8.18.1 業務內容對該業務功能的內容進行概要說明。8.28.2 處理流程簡單說明該業務的處理步驟及處理方法。對于復雜的流程，可以用流程圖的方式進行說明；對 于簡單的、流線型的處理流程可以分步驟進行說明。9.9. 其它設計對以上概要設計中未包含項目的說明，如并行處理、安全設計、內存管理等。10.10. 代碼組織10.110.1 源代碼組織結構與本模塊相關的源代碼文件有哪些，這些源代碼文件以何種目錄結構組織。10.210.2 編譯方式與本模塊相關的源代碼所屬的工程文件或makemake 文件名，編