(完整版)概要設(shè)計說明書-模板(總12頁)

1、XXX 項目概要設(shè)計說明書創(chuàng)智和宇信息技術(shù) 股份有限公司PowerSI Information Technology Co. Ltd.擬制： 審核： 文檔編號： 批準(zhǔn)： 文檔版本號： 生效日期：機密等級： 修改記錄修改記錄修訂號修訂號作者作者日期日期簡要說明簡要說明此頁由EPG編寫，項目實施人員不用更改任何地方模板編寫及修訂記錄模板編寫及修訂記錄擬制：伏亮審核：杜柏文模板編號：CZHY_TEMP_安裝部署說明書批準(zhǔn)：伍千虎版本號： V2.0生效日期：2012 年 12 月 1 日機密等級：內(nèi)部公開內(nèi)部公開修訂號修訂號作者作者日期日期簡要說明簡要說明V0.1伏亮2010 年 4 月 15 日新制

2、作V0.2伏亮2010 年 5 月 8 日評審版V1.0伏亮2010 年 6 月 1 日正式發(fā)布V1.1伏亮2012 年 11 月 29 日修改文檔格式V2.0伏亮2012 年 12 月 1 日正式發(fā)布此頁由EPG編寫，項目實施人員不用更改任何地方 目 錄XXX 項目_概要設(shè)計書.11引言.21.1編寫目的.21.2參考文獻(xiàn).21.3術(shù)語與縮寫解釋.22總體設(shè)計.22.1系統(tǒng)概述.22.2系統(tǒng)設(shè)計原則.22.3設(shè)計中應(yīng)用的關(guān)鍵技術(shù).32.4系統(tǒng)結(jié)構(gòu)圖.32.5網(wǎng)絡(luò)結(jié)構(gòu)圖.32.6系統(tǒng)功能模塊圖.32.7數(shù)據(jù)流向圖（或稱為時序圖）.32.8模塊構(gòu)成.33環(huán)境設(shè)計.44硬件設(shè)備.45支持軟件.46

3、接口設(shè)計.46.1用戶接口.46.2外部接口.46.3內(nèi)部接口.47數(shù)據(jù)庫設(shè)計.47.1數(shù)據(jù)庫環(huán)境說明.47.2數(shù)據(jù)庫命名規(guī)則.47.3邏輯設(shè)計.57.4物理設(shè)計.57.5安全性設(shè)計.68公用結(jié)構(gòu).79界面設(shè)計.710出錯處理設(shè)計.711開發(fā)工具.712附錄.71 引言1.1編寫目的說明編寫這份概要設(shè)計說明書的目的,指出預(yù)期的讀者例如： 本設(shè)計說明書簡單闡明了XXX系統(tǒng)的XXX模塊的基本設(shè)計思想、基本功能、模塊劃分以及模塊間接口。以便于各模塊開發(fā)人員能更好地了解該系統(tǒng)的基本情況及各模塊詳細(xì)功能。1.2參考文獻(xiàn)提示：列出本文檔的所有參考文獻(xiàn)（可以是非正式出版物） ，格式如下：標(biāo)識符 作者，文獻(xiàn)名

4、稱，出版單位（或歸屬單位） ，日期例如：AAA 作者， 立項調(diào)查報告 ，機構(gòu)名稱，日期BBB 作者， 立項可行性分析報告 ，機構(gòu)名稱，日期SPP-PROC-PIM EPG，立項管理規(guī)范，機構(gòu)名稱，日期1.3術(shù)語與縮寫解釋縮寫、術(shù)語縮寫、術(shù)語解解 釋釋SPP精簡并行過程，Simplified Parallel ProcessPIM立項管理，Project Initialization Management2 總體設(shè)計2.1系統(tǒng)概述說明對本系統(tǒng)或模塊的設(shè)計思想：模塊劃分原則、網(wǎng)絡(luò)設(shè)計原則、開發(fā)模型等。2.2系統(tǒng)設(shè)計原則說明本文件設(shè)計應(yīng)遵循的原則等。2.3設(shè)計中應(yīng)用的關(guān)鍵技術(shù)說明本文件設(shè)計應(yīng)用的關(guān)鍵

5、技術(shù)，如多類型空間數(shù)據(jù)集成技術(shù)、海量圖庫管理技術(shù)、國土資源信息管理的多級服務(wù)器組建技術(shù)、國土資源信息WEB發(fā)布技術(shù)、工作流驅(qū)動技術(shù)、時域GIS管理技術(shù)2.4系統(tǒng)結(jié)構(gòu)圖說明系統(tǒng)的內(nèi)部結(jié)構(gòu)，子系統(tǒng)/模塊間的聯(lián)系等，必須以圖示和文字說明相結(jié)合2.5網(wǎng)絡(luò)結(jié)構(gòu)圖說明本系統(tǒng)在整體網(wǎng)絡(luò)中的地位，及其和外界網(wǎng)絡(luò)的關(guān)系，必須以圖示和文字說明相結(jié)合2.6系統(tǒng)功能模塊圖說明本系統(tǒng)的功能模塊組成，及其各模塊間的數(shù)據(jù)接口，各模塊之間的控制與被控制關(guān)系，必須以圖示和文字說明相結(jié)合2.7數(shù)據(jù)流向圖（或稱為時序圖）說明系統(tǒng)和外界的數(shù)據(jù)交互流程，并注明數(shù)據(jù)類型或是模塊和其它模塊的數(shù)據(jù)交互流程，并注明模塊間交互的數(shù)據(jù)類型【可參考

6、需求開發(fā)指南5.2 】2.8模塊構(gòu)成系統(tǒng)劃分模塊：對系統(tǒng)(或模塊)中每一個功能，用圖示或文字詳細(xì)描述：概述 - 敘述功能名稱、目標(biāo)和作用；輸入 - 敘述該功能輸入的消息；處理 - 描述該功能做什么，如何對輸入信息進(jìn)行加工并轉(zhuǎn)換成輸出信息；輸出 - 詳述該功能輸出的信息；自主開發(fā)、復(fù)用、外包、采購方案-詳述該模塊的設(shè)計方案，包括自主開發(fā)、復(fù)用、外包、采購的選項。模塊名稱概述輸入輸出處理自主開發(fā)、復(fù)用、外包、采購方案3 環(huán)境設(shè)計簡要地說明對本系統(tǒng)的運行環(huán)境的規(guī)定4 硬件設(shè)備列出運行該軟件所需要的硬設(shè)備.說明其中的新型設(shè)備及其專門功能.5 支持軟件列出支持軟件,包括要用到的操作系統(tǒng)、編程語言、編譯(

7、或匯編)程序、測試支持軟件等及各軟件的版本。6 6 接口設(shè)計接口設(shè)計接口設(shè)計原則取得一致性取得一致性 類似的情況應(yīng)該有讓使用者有一致性的操作。在提示、選單與說明文件中，應(yīng)該采用同樣的名詞。并且保持命令的一貫性。 讓重度使用者使用快捷方式讓重度使用者使用快捷方式 當(dāng)使用頻率增加時，使用者會希望減少互動的次數(shù)、讓每次的互動能夠一次做更多的動作。縮寫、功能鍵、隱藏功能與綜觀全局的功能，對專家來說非常有用。 提供有意義的回饋提供有意義的回饋 當(dāng)使用者做出一些動作時，系統(tǒng)應(yīng)該提供回饋。越頻繁的動作，其回饋的強度可以低一些。越重要或不尋常的動作，其回饋強度應(yīng)該要顯著一些。 設(shè)計對話產(chǎn)生結(jié)束設(shè)計對話產(chǎn)生結(jié)束

8、 一連串的動作應(yīng)該被組織成開始、中間、結(jié)束三部份。當(dāng)動作結(jié)束的時候，要提供回饋讓使用者知道動作已經(jīng)完成。在做下個一連串的動作之前，先告知使用者整個流程，能夠減輕使用者的壓力、提高滿意度。 提供簡單的錯誤處理提供簡單的錯誤處理 最好不要讓系統(tǒng)有嚴(yán)重錯誤的可能性。如果還是造成錯誤，系統(tǒng)應(yīng)該能夠偵測出來，并提供一個簡單、使用者可以理解的錯誤處理方式。允許回到上一步允許回到上一步 這個功能可以減低使用者的焦慮，因為使用者只到做錯了可以重來。這個功能鼓勵使用者探索不熟悉的選項?；氐缴弦徊降墓δ埽梢园粋€、或是一連串的動作。 滿足使用者控制的需求滿足使用者控制的需求 有經(jīng)驗的使用者強烈的感覺到他們在控

9、制系統(tǒng)，做出動作之后，系統(tǒng)提供回饋。系統(tǒng)設(shè)計上要讓使用者作為動作的處發(fā)者，而不是響應(yīng)者。 減少短期記憶需求減少短期記憶需求 人類的短期記憶有限，因此顯示上要保持簡單、能同時顯示多頁數(shù)據(jù)以減少窗口切換頻率，減少記憶指令和動作順序的時間。設(shè)計方法接口是提供給其他模塊或者系統(tǒng)使用的一種約定或者規(guī)范。因此接口必須要保證足夠的穩(wěn)定性和易用性。這是設(shè)計接口的基本要求。1.穩(wěn)定性接口必須相對穩(wěn)定，否則將導(dǎo)致接口的使用者和提供者為了適應(yīng)新接口而不斷修改接口的實現(xiàn)，可能重復(fù)進(jìn)行無用功，嚴(yán)重時影響整個軟件開發(fā)進(jìn)度。那么如何保證設(shè)計的接口相對穩(wěn)定呢？首先，接口的語義必須明確。包括接口調(diào)用方法、接口名稱、參數(shù)的類型和

10、名稱。抽象的接口名稱或者參數(shù)名稱使人困惑或者理解錯誤。如下例：History:SetAttribute 設(shè)置歷史記錄的屬性，初看不知道該接口要做什么。除非History的屬性很多否則沒有必要設(shè)計這樣的接口。ioctlC庫中的ioctl，其實很難用原因是需要設(shè)置項太多，每個項的參數(shù)又不太一致，接口使用者的壓力就較大了。但是接口設(shè)計者也是不得已而為之，由于IO的設(shè)置接口的應(yīng)用情況較多，如果每個設(shè)置接口都單獨提供一個接口則會導(dǎo)致非常多的接口，另外就是保證接口的相對穩(wěn)定，采用抽象的數(shù)據(jù)的接口便于移植和穩(wěn)定。因此，明確的接口語義例外情況就是對于輔助功能，如果需要較多接口，則可以合成一個接口，采用不同參數(shù)

11、區(qū)分（如windows中的窗口處理過程類型的定義也是這種情況） 。 其次，采用版本定義來區(qū)分接口的差異。比如提供接口版本查詢功能，接口實現(xiàn)著提供接口版本的查詢功能。2.易用性 接口是提供給第三方使用的，較難用的接口會導(dǎo)致接口使用者的抱怨。 如： SetCookie(void* handle, const CookieParam& param); GetCookie(void* handle, CookieParam& param);此接口名稱的意義還是比較明確的，但是參數(shù)CookieParam過于抽象，將導(dǎo)致接口的調(diào)用者在使用接口時，需要將基本數(shù)據(jù)類型的值組成一個CookieParam類型，然

12、后才能調(diào)用接口。這是一種糟糕的接口設(shè)計。既不便于使用又不便于編譯器優(yōu)化（待確認(rèn)） 如果該為下面的接口則較容易使用 SetCookie(void* handle, const URL& url, const String& cookie); GetCookie(void* handle, const URL& url, String cookie);除非接口的參數(shù)個數(shù)超過5個，否則最好采用基本數(shù)據(jù)類型作為參數(shù)。超過5個參數(shù)的函數(shù)一方面給調(diào)用者帶來困難，參數(shù)排列組合的情況過多，另一方面就是不利于編譯器優(yōu)化時采用寄存器傳遞參數(shù)。6.1用戶接口說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及相應(yīng)的回答信息

13、。 說明提供給用戶操作的用戶界面采用的形式，如屏幕格式、報表格式、菜單格式等6.2外部接口說明本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持系統(tǒng)之間的接口關(guān)系。，配置文件。6.3內(nèi)部接口說明本系統(tǒng)之內(nèi)的各個系統(tǒng)元素之間的接口的安排。，配置文件等。7 7 制作購買重用分析制作購買重用分析軟件復(fù)用有三個基本原則：（1）必須有可以復(fù)用的對象；（2）所設(shè)計的可復(fù)用對象必須是有用的；（3）復(fù)用者需要知道如何使用被復(fù)用的對象。軟件復(fù)用包括兩個相關(guān)過程：即可復(fù)用軟件（構(gòu)件）或軟件的可復(fù)用部分的開發(fā)(Development for Reuse)和基于可復(fù)用軟件（構(gòu)件）或軟件可復(fù)用的部分的

14、應(yīng)用系統(tǒng)構(gòu)造（集成和組裝） （Development with Reuse） 。采用軟件復(fù)用技術(shù)主要有以下優(yōu)點：（1）提高軟件生產(chǎn)率、減少開發(fā)時間；（2）提高軟件質(zhì)量，開發(fā)出來的軟件可靠性高；（3）降低開發(fā)風(fēng)險；（4）簡化軟件開發(fā)流程，使得軟件開發(fā)易于管理；（5）降低維護難度、工作量和費用，提高了軟件系統(tǒng)效益；（6）便于學(xué)習(xí)系統(tǒng)結(jié)構(gòu)和建立好的系統(tǒng)，促進(jìn)軟件開發(fā)過程的標(biāo)準(zhǔn)化；（7）易于提供文檔資料等。軟件外購的原則（1）外購費用小于開發(fā)人力成本。（2）外購軟件能大量縮短工期。（3）外購軟件集成成本小于項目成本的 1%。（4）外購軟件技術(shù)是本公司急切需要的。7.1外購模塊的設(shè)計簡要地說明本系統(tǒng)的需

15、要外購的模塊及外購原因，存在的問題和注意事項7.2復(fù)用模塊的設(shè)計簡要地說明本系統(tǒng)的需要復(fù)用的模塊及復(fù)用的原因，存在的問題和注意事項8 數(shù)據(jù)庫設(shè)計客戶化開發(fā)類、維護類項目可將數(shù)據(jù)庫設(shè)計獨立一份文檔，見數(shù)據(jù)庫設(shè)計說明書8.1數(shù)據(jù)庫環(huán)境說明說明所采用的數(shù)據(jù)庫系統(tǒng)，設(shè)計工具，編程工具等。8.2數(shù)據(jù)庫命名規(guī)則提示：（1） 完整并且清楚的說明本數(shù)據(jù)庫的命名規(guī)則。數(shù)據(jù)庫表的命名規(guī)則列的命名規(guī)則存儲過程的命名規(guī)則觸發(fā)器的命名規(guī)則（2）如果本數(shù)據(jù)庫的命名規(guī)則與機構(gòu)的標(biāo)準(zhǔn)不完全一致的話，請作出解釋。 8.3邏輯設(shè)計數(shù)據(jù)庫設(shè)計人員根據(jù)需求文檔，創(chuàng)建與數(shù)據(jù)庫相關(guān)的那部分實體關(guān)系圖（ERD） 。如果采用面向?qū)ο蠓椒ǎ∣

16、OAD） ，這里實體相當(dāng)于類（class） 。8.4物理設(shè)計主要是設(shè)計表結(jié)構(gòu)。一般地，實體對應(yīng)于表，實體的屬性對應(yīng)于表的列，實體之間的關(guān)系成為表的約束。邏輯設(shè)計中的實體大部分可以轉(zhuǎn)換成物理設(shè)計中的表，但是它們并不一定是一一對應(yīng)的。對表結(jié)構(gòu)進(jìn)行規(guī)范化處理（第三范式） 。8.4.1 表匯總表匯總表名功能說明Sys_dict數(shù)據(jù)字典表8.4.2 Sys_dict（數(shù)據(jù)字典表）（數(shù)據(jù)字典表）表名：Sys_dict用戶模式：分區(qū)：無索引：group_id+dict_id（key）實體存放： 用途說明：維 護： 字段名字段名數(shù)據(jù)類型數(shù)據(jù)類型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備注8.5安全性設(shè)計8.5.1 防止用戶直防止用戶直接操作數(shù)據(jù)庫的方法接操作數(shù)據(jù)庫的方法提示：用戶只能用帳號登陸到應(yīng)用軟件，通過應(yīng)用軟件訪問數(shù)據(jù)庫，而沒有其它途徑操作數(shù)據(jù)庫。8.5.2 用戶帳號密碼的加密方法用戶帳號密碼的加密方法提示：對用戶帳號的密碼進(jìn)行加密處理，確保在任何地方都不會