XXX項目概要設計說明書創(chuàng)智和宇信息技術股份有限公司PowerSIInformationTechnologyCo.Ltd。擬制：文檔編號：審核：批準：文檔版本號:生效日期：機密等級：修改記錄修訂號作者日期簡要說明

此頁由EPG編寫，項目實施人員不用更改任何地方模板編寫及修訂記錄擬制:伏亮模板編號:CZHY_TEMP_安裝部署說明書審核：杜柏文批準:伍千虎版本號:V2.0生效日期：2012年12月1日機密等級：內部公開修訂號作者日期簡要說明V0.1伏亮2010年4月15日新制作V0.2伏亮2010年5月8日評審版V1。0伏亮2010年6月1日正式發(fā)布V1.1伏亮2012年11月29日修改文檔格式V2.0伏亮2012年12月1日正式發(fā)布此頁由EPG編寫，項目實施人員不用更改任何地方目錄TOC\o"1—2"\h\z\u_Toc229989531"1 引言 2HYPERLINK\l”_Toc229989532"1.1 編寫目的 2_Toc229989534"1.3 術語與縮寫解釋 2HYPERLINK\l”_Toc229989535"2 總體設計 22.1 系統(tǒng)概述 2HYPERLINK\l”_Toc229989537”2.2 系統(tǒng)設計原則 2HYPERLINK\l”_Toc229989538"2。3 設計中應用的關鍵技術 32。4 系統(tǒng)結構圖 3HYPERLINK\l”_Toc229989540”2.5 網絡結構圖 32。6 系統(tǒng)功能模塊圖 3_Toc229989543"2.8 模塊構成 3_Toc229989549"6。2 外部接口 46.3 內部接口 4_Toc229989552”7。1 數據庫環(huán)境說明 47.4 物理設計 5HYPERLINK\l”_Toc229989556"7。5 安全性設計 6HYPERLINK\l”_Toc229989557”8 公用結構 79 界面設計 7HYPERLINK\l”_Toc229989559”10 出錯處理設計 7HYPERLINK\l”_Toc229989560”11 開發(fā)工具 7HYPERLINK\l”_Toc229989561”12 附錄 7引言編寫目的［說明編寫這份概要設計說明書的目的，指出預期的讀者]例如：本設計說明書簡單闡明了XXX系統(tǒng)的XXX模塊的基本設計思想、基本功能、模塊劃分以及模塊間接口。以便于各模塊開發(fā)人員能更好地了解該系統(tǒng)的基本情況及各模塊詳細功能。參考文獻提示：列出本文檔的所有參考文獻（可以是非正式出版物）,格式如下：[標識符］作者，文獻名稱,出版單位（或歸屬單位），日期例如：[AAA］作者,《立項調查報告》，機構名稱，日期［BBB]作者,《立項可行性分析報告》,機構名稱，日期［SPP-PROC—PIM]EPG，立項管理規(guī)范，機構名稱,日期術語與縮寫解釋縮寫、術語解釋SPP精簡并行過程，SimplifiedParallelProcessPIM立項管理，ProjectInitializationManagement…總體設計系統(tǒng)概述[說明對本系統(tǒng)或模塊的設計思想：模塊劃分原則、網絡設計原則、開發(fā)模型等。]系統(tǒng)設計原則[說明本文件設計應遵循的原則等.］設計中應用的關鍵技術[說明本文件設計應用的關鍵技術，如多類型空間數據集成技術、海量圖庫管理技術、國土資源信息管理的多級服務器組建技術、國土資源信息WEB發(fā)布技術、工作流驅動技術、時域GIS管理技術］系統(tǒng)結構圖［說明系統(tǒng)的內部結構，子系統(tǒng)/模塊間的聯系等，必須以圖示和文字說明相結合］網絡結構圖[說明本系統(tǒng)在整體網絡中的地位，及其和外界網絡的關系，必須以圖示和文字說明相結合]系統(tǒng)功能模塊圖［說明本系統(tǒng)的功能模塊組成，及其各模塊間的數據接口,各模塊之間的控制與被控制關系，必須以圖示和文字說明相結合］數據流向圖（或稱為時序圖）［說明系統(tǒng)和外界的數據交互流程,并注明數據類型或是模塊和其它模塊的數據交互流程，并注明模塊間交互的數據類型]【可參考《需求開發(fā)指南5.2》】模塊構成系統(tǒng)劃分模塊：對系統(tǒng)（或模塊)中每一個功能，用圖示或文字詳細描述：概述-—-敘述功能名稱、目標和作用；輸入——-敘述該功能輸入的消息；處理-—-描述該功能做什么，如何對輸入信息進行加工并轉換成輸出信息；輸出--—詳述該功能輸出的信息;自主開發(fā)、復用、外包、采購方案——-詳述該模塊的設計方案，包括自主開發(fā)、復用、外包、采購的選項。模塊名稱概述輸入輸出處理自主開發(fā)、復用、外包、采購方案環(huán)境設計[簡要地說明對本系統(tǒng)的運行環(huán)境的規(guī)定]硬件設備[列出運行該軟件所需要的硬設備。說明其中的新型設備及其專門功能。］支持軟件［列出支持軟件，包括要用到的操作系統(tǒng)、編程語言、編譯（或匯編）程序、測試支持軟件等及各軟件的版本。]接口設計接口設計原則取得一致性類似的情況應該有讓使用者有一致性的操作。在提示、選單與說明文件中，應該采用同樣的名詞。并且保持命令的一貫性。讓重度使用者使用快捷方式當使用頻率增加時，使用者會希望減少互動的次數、讓每次的互動能夠一次做更多的動作?？s寫、功能鍵、隱藏功能與綜觀全局的功能，對專家來說非常有用.提供有意義的回饋當使用者做出一些動作時,系統(tǒng)應該提供回饋。越頻繁的動作,其回饋的強度可以低一些。越重要或不尋常的動作，其回饋強度應該要顯著一些。設計對話產生結束一連串的動作應該被組織成開始、中間、結束三部份。當動作結束的時候，要提供回饋讓使用者知道動作已經完成。在做下個一連串的動作之前，先告知使用者整個流程,能夠減輕使用者的壓力、提高滿意度。提供簡單的錯誤處理最好不要讓系統(tǒng)有嚴重錯誤的可能性.如果還是造成錯誤，系統(tǒng)應該能夠偵測出來，并提供一個簡單、使用者可以理解的錯誤處理方式.允許回到上一步這個功能可以減低使用者的焦慮，因為使用者只到做錯了可以重來。這個功能鼓勵使用者探索不熟悉的選項?；氐缴弦徊降墓δ?，可以包含一個、或是一連串的動作。滿足使用者控制的需求有經驗的使用者強烈的感覺到他們在控制系統(tǒng),做出動作之后，系統(tǒng)提供回饋.系統(tǒng)設計上要讓使用者作為動作的處發(fā)者，而不是響應者。減少短期記憶需求人類的短期記憶有限,因此顯示上要保持簡單、能同時顯示多頁數據以減少窗口切換頻率，減少記憶指令和動作順序的時間。設計方法接口是提供給其他模塊或者系統(tǒng)使用的一種約定或者規(guī)范。因此接口必須要保證足夠的穩(wěn)定性和易用性.這是設計接口的基本要求。1.穩(wěn)定性接口必須相對穩(wěn)定，否則將導致接口的使用者和提供者為了適應新接口而不斷修改接口的實現，可能重復進行無用功,嚴重時影響整個軟件開發(fā)進度。那么如何保證設計的接口相對穩(wěn)定呢?首先,接口的語義必須明確。包括接口調用方法、接口名稱、參數的類型和名稱。抽象的接口名稱或者參數名稱使人困惑或者理解錯誤。如下例：History：：SetAttribute設置歷史記錄的屬性，初看不知道該接口要做什么。除非History的屬性很多否則沒有必要設計這樣的接口。ioctlC庫中的ioctl，其實很難用原因是需要設置項太多，每個項的參數又不太一致，接口使用者的壓力就較大了。但是接口設計者也是不得已而為之，由于IO的設置接口的應用情況較多，如果每個設置接口都單獨提供一個接口則會導致非常多的接口，另外就是保證接口的相對穩(wěn)定，采用抽象的數據的接口便于移植和穩(wěn)定。因此，明確的接口語義例外情況就是對于輔助功能，如果需要較多接口,則可以合成一個接口，采用不同參數區(qū)分（如windows中的窗口處理過程類型的定義也是這種情況)。其次，采用版本定義來區(qū)分接口的差異。比如提供接口版本查詢功能,接口實現著提供接口版本的查詢功能。2。易用性接口是提供給第三方使用的，較難用的接口會導致接口使用者的抱怨。如：SetCookie（void＊handle,constCookieParam¶m）;GetCookie(void*handle,CookieParam＆param）；此接口名稱的意義還是比較明確的,但是參數CookieParam過于抽象,將導致接口的調用者在使用接口時,需要將基本數據類型的值組成一個CookieParam類型,然后才能調用接口。這是一種糟糕的接口設計。既不便于使用又不便于編譯器優(yōu)化(待確認）如果該為下面的接口則較容易使用SetCookie(void＊handle，constURL&url,constString&cookie）;GetCookie（void*handle,constURL＆url,Stringcookie)；除非接口的參數個數超過5個，否則最好采用基本數據類型作為參數。超過5個參數的函數一方面給調用者帶來困難，參數排列組合的情況過多，另一方面就是不利于編譯器優(yōu)化時采用寄存器傳遞參數。用戶接口［說明將向用戶提供的命令和它們的語法結構,以及相應的回答信息.］[說明提供給用戶操作的用戶界面采用的形式，如屏幕格式、報表格式、菜單格式等]外部接口[說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持系統(tǒng)之間的接口關系。］，配置文件.內部接口[說明本系統(tǒng)之內的各個系統(tǒng)元素之間的接口的安排。］，配置文件等.制作購買重用分析軟件復用有三個基本原則：（1）必須有可以復用的對象；（2)所設計的可復用對象必須是有用的;(3）復用者需要知道如何使用被復用的對象。軟件復用包括兩個相關過程：即可復用軟件(構件）或軟件的可復用部分的開發(fā)(DevelopmentforReuse)和基于可復用軟件（構件）或軟件可復用的部分的應用系統(tǒng)構造（集成和組裝）（DevelopmentwithReuse）.采用軟件復用技術主要有以下優(yōu)點:（1)提高軟件生產率、減少開發(fā)時間；（2）提高軟件質量，開發(fā)出來的軟件可靠性高；（3)降低開發(fā)風險；（4)簡化軟件開發(fā)流程，使得軟件開發(fā)易于管理；（5）降低維護難度、工作量和費用,提高了軟件系統(tǒng)效益;（6)便于學習系統(tǒng)結構和建立好的系統(tǒng)，促進軟件開發(fā)過程的標準化；（7）易于提供文檔資料等.軟件外購的原則（1）外購費用小于開發(fā)人力成本。（2）外購軟件能大量縮短工期。（3)外購軟件集成成本小于項目成本的1％.（4）外購軟件技術是本公司急切需要的。外購模塊的設計［簡要地說明本系統(tǒng)的需要外購的模塊及外購原因，存在的問題和注意事項]復用模塊的設計［簡要地說明本系統(tǒng)的需要復用的模塊及復用的原因，存在的問題和注意事項]數據庫設計［客戶化開發(fā)類、維護類項目可將數據庫設計獨立一份文檔,見《數據庫設計說明書》］數據庫環(huán)境說明［說明所采用的數據庫系統(tǒng)，設計工具,編程工具等。］數據庫命名規(guī)則[提示：完整并且清楚的說明本數據庫的命名規(guī)則。數據庫表的命名規(guī)則列的命名規(guī)則存儲過程的命名規(guī)則觸發(fā)器的命名規(guī)則（2）如果本數據庫的命名規(guī)則與機構的標準不完全一致的話，請作出解釋。

]邏輯設計[數據庫設計人員根據需求文檔,創(chuàng)建與數據庫相關的那部分實體關系圖（ERD）.如果采用面向對象方法（OOAD），這里實體相當于類(class）。]物理設計［主要是設計表結構。一般地，實體對應于表，實體的屬性對應于表的列,實體之間的關系成為表的約束。邏輯設計中的實體大部分可以轉換成物理設計中的表，但是它們并不一定是一一對應的.對表結構進行規(guī)范化處理(第三范式）。]表匯總表名功能說明Sys_dict數據字典表…………Sys_dict（數據字典表)表名：Sys_dict用戶模式:分區(qū):無索引：group_id+dict_id(key）實體存放：用途說明：維護：字段名數據類型NULL中文說明group_idNumber(8）NN組編碼Group_nameVarchar2（80)NN組名稱dict_idNumber(8)NN字典編碼dict_nameVarchar2（80)NN字典名稱Dict_valueVarchar2(255)NN字典值Dict_indexNumber(3)N字典順序remarkVarchar2(255)N備注安全性設計防止用戶直接操作數據庫的方法［提示：用戶只能用帳號登陸到應用軟件，通過應用軟件訪問數據庫，而沒有其它途徑操作數據庫。］用戶帳號密碼的加密方法［提示：對用戶帳號的密碼