XXX項目概要設計描述書2020年12月修訂記錄版本*變化狀態(tài)描述日期修訂者*變化狀態(tài)（A-添加，M-修改，D-刪除）

目錄TOC\o"1-2"\h\z\u1 引言 11.1目的 11.2參考文獻 11.3術語描述 12 總體設計 12.1系統(tǒng)概述 12.2系統(tǒng)設計原則 12.3應用的關鍵技術 22.4系統(tǒng)結構圖 22.5系統(tǒng)功能模塊圖 22.6模塊構成 22.7數(shù)據(jù)流向圖 22.8網(wǎng)絡結構圖 23 硬件設備 34 支持軟件 35 數(shù)據(jù)庫設計 35.1數(shù)據(jù)庫環(huán)境描述 35.2數(shù)據(jù)庫命名規(guī)則 35.3邏輯設計 35.4物理設計 35.5表匯總 45.6數(shù)據(jù)字典表 45.7安全性設計 46 接口設計 56.1接口設計原則 56.2設計方法 56.3用戶接口 76.4外部接口 76.5內(nèi)部接口 77 制作購買重用分析 77.1外購模塊的設計 87.2復用模塊的設計 88 界面設計 89 附錄 8引言1.1目的[闡述本文檔目的]范文：本設計描述書詳細闡明了XXX系統(tǒng)基本設計思想、基本功能、模塊劃分以及模塊間接口。以便于各模塊開發(fā)人員能更好地了解該系統(tǒng)的基本情況及各模塊詳細功能。1.2參考文獻列出編寫本描述書需要參考的文檔資料文檔名稱，文檔版本范文：《立項描述書》《立項可行性分析報告》GB/T8567計算機軟件文檔編制規(guī)范GB/T9385計算機軟件需求規(guī)格描述規(guī)范1.3術語描述縮寫、術語解釋總體設計2.1系統(tǒng)概述[描述本系統(tǒng)和模塊的設計思想：模塊劃分原則、結構設計原則、模塊主要功能等。]2.2系統(tǒng)設計原則[描述概要設計應遵循的原則]2.3應用的關鍵技術［描述本文件設計應用的關鍵技術，如大數(shù)據(jù)hadoop、JAVAspringboot、多級服務器組建技術、分級部署等］2.4系統(tǒng)結構圖[描述系統(tǒng)的內(nèi)部結構，子系統(tǒng)/模塊間的聯(lián)系等，必須以圖示和文字描述相結合]2.5系統(tǒng)功能模塊圖[描述本系統(tǒng)的功能模塊組成，及其各模塊間的數(shù)據(jù)接口，各模塊之間的控制與被控制關系，必須以圖示和文字描述相結合]2.6模塊構成系統(tǒng)劃分模塊：對系統(tǒng)(或模塊)中每一個功能，用圖示或文字詳細描述：概述敘述功能名稱、目標和作用；輸入敘述該功能輸入的消息；處理描述該功能做什么，如何對輸入信息進行加工并轉換成輸出信息；輸出詳述該功能輸出的信息；方式自主開發(fā)、復用、外包、采購方案詳述該模塊的設計方案，包括自主開發(fā)、復用、外包、采購的選項。模塊名稱概述輸入輸出處理方式自主開發(fā)、復用、外包、2.7數(shù)據(jù)流向圖[描述系統(tǒng)和外界的數(shù)據(jù)交互流程，并注明數(shù)據(jù)類型或是模塊和其它模塊的數(shù)據(jù)交互流程，并注明模塊間交互的數(shù)據(jù)類型]2.8網(wǎng)絡結構圖[描述本系統(tǒng)在整體網(wǎng)絡中的地位，及其和外界網(wǎng)絡的關系，必須以圖示和文字描述相結合]硬件設備[列出運行該軟件所需要的硬設備.描述其中的新型設備及其專門功能.]支持軟件[列出支持軟件,包括要用到的操作系統(tǒng)、編程語言、編譯(或匯編)程序、測試支持軟件等及各軟件的版本。]數(shù)據(jù)庫設計[客戶化開發(fā)類、維護類項目可將數(shù)據(jù)庫設計獨立一份文檔，見《數(shù)據(jù)庫設計說明書》]5.1數(shù)據(jù)庫環(huán)境描述[描述所采用的數(shù)據(jù)庫系統(tǒng)，設計工具，編程工具等。]5.2數(shù)據(jù)庫命名規(guī)則[提示：（1）完整并且清楚的描述本數(shù)據(jù)庫的命名規(guī)則。數(shù)據(jù)庫表的命名規(guī)則列的命名規(guī)則存儲過程的命名規(guī)則觸發(fā)器的命名規(guī)則（2）如果本數(shù)據(jù)庫的命名規(guī)則與機構的標準不完全一致的話，請作出解釋。

]5.3邏輯設計[數(shù)據(jù)庫設計人員根據(jù)需求文檔，創(chuàng)建與數(shù)據(jù)庫相關的那部分實體關系圖（ERD）。如果采用面向對象方法（OOAD），這里實體相當于類（class）。]5.4物理設計[主要是設計表結構。一般地，實體對應于表，實體的屬性對應于表的列，實體之間的關系成為表的約束。邏輯設計中的實體大部分可以轉換成物理設計中的表，但是它們并不一定是一一對應的。對表結構進行規(guī)范化處理（第三范式）。]5.5表匯總表名功能描述Sys_dict數(shù)據(jù)字典表…………5.6數(shù)據(jù)字典表表名：Sys_code索引：group_id+dict_id（key）字段名數(shù)據(jù)類型NULL中文描述code_idNumber(8)NN代碼編號code_nameVarchar2(80)NN代碼名稱dict_idNumber(8)NN字典編碼dict_nameVarchar2(80)NN字典名稱Dict_valueVarchar2(255)NN字典值Dict_indexNumber(3)N字典順序remarkVarchar2(255)N備注5.7安全性設計5.7.1防止用戶直接操作數(shù)據(jù)庫的方法[提示：用戶只能用帳號登陸到應用軟件，通過應用軟件訪問數(shù)據(jù)庫，而沒有其它途徑操作數(shù)據(jù)庫。]5.7.2用戶帳號密碼的加密方法[提示：對用戶帳號的密碼進行加密處理，確保在任何地方都不會出現(xiàn)密碼的明文。]5.7.3角色與權限[提示：確定每個角色對數(shù)據(jù)庫表的操作權限，如創(chuàng)建、檢索、更新、刪除等。每個角色擁有剛好能夠完成任務的權限，不多也不少。在應用時再為用戶分配角色，則每個用戶的權限等于他所兼角色的權限之和。]角色可以訪問的表與列操作權限角色A角色B接口設計6.1接口設計原則取得一致性類似的情況應該有讓使用者有一致性的操作。在提示、選單與描述文件中，應該采用同樣的名詞。并且保持命令的一貫性。讓重度使用者使用快捷方式當使用頻率增加時，使用者會希望減少互動的次數(shù)、讓每次的互動能夠一次做更多的動作?？s寫、功能鍵、隱藏功能與綜觀全局的功能，對專家來說非常有用。提供有意義的回饋當使用者做出一些動作時，系統(tǒng)應該提供回饋。越頻繁的動作，其回饋的強度可以低一些。越重要或不尋常的動作，其回饋強度應該要顯著一些。設計對話產(chǎn)生結束6.2設計方法接口是提供給其他模塊或者系統(tǒng)使用的一種約定或者規(guī)范。因此接口必須要保證足夠的穩(wěn)定性和易用性。這是設計接口的基本要求。1.穩(wěn)定性接口必須相對穩(wěn)定，否則將導致接口的使用者和提供者為了適應新接口而不斷修改接口的實現(xiàn)，可能重復進行無用功，嚴重時影響整個軟件開發(fā)進度。那么如何保證設計的接口相對穩(wěn)定呢？首先，接口的語義必須明確。包括接口調用方法、接口名稱、參數(shù)的類型和名稱。抽象的接口名稱或者參數(shù)名稱使人困惑或者理解錯誤。如下例：History::SetAttribute設置歷史記錄的屬性，初看不知道該接口要做什么。除非History的屬性很多否則沒有必要設計這樣的接口。ioctlC庫中的ioctl，其實很難用原因是需要設置項太多，每個項的參數(shù)又不太一致，接口使用者的壓力就較大了。但是接口設計者也是不得已而為之，由于IO的設置接口的應用情況較多，如果每個設置接口都單獨提供一個接口則會導致非常多的接口，另外就是保證接口的相對穩(wěn)定，采用抽象的數(shù)據(jù)的接口便于移植和穩(wěn)定。因此，明確的接口語義例外情況就是對于輔助功能，如果需要較多接口，則可以合成一個接口，采用不同參數(shù)區(qū)分（如windows中的窗口處理過程類型的定義也是這種情況）。其次，采用版本定義來區(qū)分接口的差異。比如提供接口版本查詢功能，接口實現(xiàn)著提供接口版本的查詢功能。2.易用性接口是提供給第三方使用的，較難用的接口會導致接口使用者的抱怨。如：SetCookie(void*handle,constCookieParam¶m);GetCookie(void*handle,CookieParam¶m);此接口名稱的意義還是比較明確的，但是參數(shù)CookieParam過于抽象，將導致接口的調用者在使用接口時，需要將基本數(shù)據(jù)類型的值組成一個CookieParam類型，然后才能調用接口。這是一種糟糕的接口設計。既不便于使用又不便于編譯器優(yōu)化（待確認）如果該為下面的接口則較容易使用SetCookie(void*handle,constURL&url,constString&cookie);GetCookie(void*handle,constURL&url,Stringcookie);除非接口的參數(shù)個數(shù)超過5個，否則最好采用基本數(shù)據(jù)類型作為參數(shù)。超過5個參數(shù)的函數(shù)一方面給調用者帶來困難，參數(shù)排列組合的情況過多，另一方面就是不利于編譯器優(yōu)化時采用寄存器傳遞參數(shù)。6.3用戶接口[描述提供給用戶操作的用戶界面采用的形式，如屏幕格式、報表格式、菜單格式等]6.4外部接口[描述本系統(tǒng)同外界的所有接口的安排包括軟件與硬件之間的接口、本系統(tǒng)與各支持系統(tǒng)之間的接口關系。]，配置文件。6.5內(nèi)部接口[描述本系統(tǒng)之內(nèi)的各個系統(tǒng)元素之間的接口的安排。]，配置文件等。制作購買重用分析軟件復用有三個基本原則：（1）必須有可以復用的對象；（2）所設計的可復用對象必須是有用的；（3）復用者需要知道如何使用被復用的對象。軟件復用包括兩個相關過程：即可復用軟件（構件）或軟件的可復用部分的開發(fā)(DevelopmentforReuse)和基于可復用軟件（構件）或軟件可復用的部分的應用系統(tǒng)構造（集成和組裝）（DevelopmentwithReuse）。采用軟件復用技術主要有以下優(yōu)點：（1）提高軟件生產(chǎn)率、減少開發(fā)時間；（2）提高軟件質量，開發(fā)出來的軟件可靠性高；（3）降低開發(fā)風險；（4）簡化軟件開發(fā)流程，使得軟件開發(fā)易于管理；（5）降低維護難度、工作量和費用，提高了軟件系統(tǒng)效益；（6）便于學習系統(tǒng)結構和建立好的系統(tǒng)，促進軟件開發(fā)過程的標準化；（7）易于提供文檔資料等。軟件外購的原則（1）外購費用小于開發(fā)人力成本。（2）外購軟件能大量縮短工期。（3）外購軟件集成成本小于項目成本的1%。（4）外購軟件技術是本