概要設(shè)計(jì)說明書-模板

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

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

]邏輯設(shè)計(jì)[數(shù)據(jù)庫設(shè)計(jì)人員根據(jù)需求文檔,創(chuàng)建與數(shù)據(jù)庫相關(guān)的那部分實(shí)體關(guān)系圖（ERD）.如果采用面向?qū)ο蠓椒ǎ∣OAD），這里實(shí)體相當(dāng)于類(class）。]物理設(shè)計(jì)［主要是設(shè)計(jì)表結(jié)構(gòu)。一般地，實(shí)體對(duì)應(yīng)于表，實(shí)體的屬性對(duì)應(yīng)于表的列,實(shí)體之間的關(guān)系成為表的約束。邏輯設(shè)計(jì)中的實(shí)體大部分可以轉(zhuǎn)換成物理設(shè)計(jì)中的表，但是它們并不一定是一一對(duì)應(yīng)的.對(duì)表結(jié)構(gòu)進(jìn)行規(guī)范化處理(第三范式）。]表匯總表名功能說明Sys_dict數(shù)據(jù)字典表…………Sys_dict（數(shù)據(jù)字典表)表名：Sys_dict用戶模式:分區(qū):無索引：group_id+dict_id(key）實(shí)體存放：用途說明：維護(hù)：字段名數(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備注安全性設(shè)計(jì)防止用戶直接操作數(shù)據(jù)庫的方法［提示：用戶只能用帳號(hào)登陸到應(yīng)用軟件，通過應(yīng)用軟件訪問數(shù)據(jù)庫，而沒有其它途徑操作數(shù)據(jù)庫。］用戶帳號(hào)密碼的加密方法［提示：對(duì)用戶帳號(hào)的密碼