軟件項(xiàng)目概要設(shè)計(jì)說明書(模板)

1、精選文檔_軟件項(xiàng)目概要設(shè)計(jì)說明書版 本：編 制：審 核：批 準(zhǔn)：頒布日期：2017 年 4 月 18 日受控狀態(tài)：受控非受控分發(fā)范圍：項(xiàng)目組、財(cái)務(wù)部、質(zhì)量管理部 精選文檔修訂記錄修訂日期修訂日期版本號(hào)版本號(hào)修訂描述修訂描述修訂人修訂人批準(zhǔn)人批準(zhǔn)人精選文檔目目 錄錄1 引言.11.1概述.11.2目的.11.3范圍.11.4縮略語(yǔ).11.5術(shù)語(yǔ).22 參考資料.23 交付需求列表.24 系統(tǒng)物理架構(gòu).24.1系統(tǒng)運(yùn)行的硬件環(huán)境.24.2系統(tǒng)運(yùn)行的軟件環(huán)境.34.3系統(tǒng)運(yùn)行的網(wǎng)絡(luò)環(huán)境.34.4系統(tǒng)部署圖.34.5安裝部署說明.45 系統(tǒng)邏輯架構(gòu).55.1子系統(tǒng)一.51.1.1子模塊一.51.1.2

2、子模塊二.55.2子系統(tǒng)二.56 實(shí)現(xiàn)視圖.57 進(jìn)程視圖.68 數(shù)據(jù)庫(kù)設(shè)計(jì).69 設(shè)計(jì)約束.610 內(nèi)部接口定義.611 外部接口.612 開發(fā)環(huán)境說明.713 技術(shù)難點(diǎn).714 附錄.814.1模型文件.814.2XXXX.8精選文檔_軟件項(xiàng)目概要設(shè)計(jì)說明書1 引言引言1.1概述概述應(yīng)包括： a.項(xiàng)目的委托單位、開發(fā)單位和主管部門；b.該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。本項(xiàng)目交辦方為，承辦方為 。1.2 目的目的闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對(duì)象。本文檔是在用戶和開發(fā)方對(duì)系統(tǒng)進(jìn)行需求開發(fā)，形成軟件需求規(guī)格說明書后，設(shè)計(jì)人員分析各個(gè)詳細(xì)需求后，對(duì)軟件的概要設(shè)計(jì)。本文檔作為軟件概要設(shè)計(jì)和軟件

3、詳細(xì)設(shè)計(jì)的重要依據(jù)。軟件概要設(shè)計(jì)人員和軟件詳細(xì)設(shè)計(jì)人員依此作為工作依據(jù)。1.3 讀者對(duì)象讀者對(duì)象本系統(tǒng)設(shè)計(jì)說明書的使用讀者為：業(yè)務(wù)經(jīng)理、軟件設(shè)計(jì)、UI 設(shè)計(jì)人員、測(cè)試人員。1.4 范圍范圍概要設(shè)計(jì)要考慮對(duì)架構(gòu)有影響的需求，將系統(tǒng)劃分為子系統(tǒng)一，子系統(tǒng)二，從物理架構(gòu)，邏輯架構(gòu)，實(shí)現(xiàn)視圖，進(jìn)程視圖等四個(gè)方面對(duì)架構(gòu)進(jìn)行描述，定義子系統(tǒng)之間的接口，明確系統(tǒng)依賴的外部接口，說明系統(tǒng)開發(fā)準(zhǔn)則，選取開發(fā)環(huán)境，對(duì)技術(shù)難點(diǎn)進(jìn)行分析說明。1.5 縮略縮略和術(shù)語(yǔ)和術(shù)語(yǔ)Table 1-1 縮略語(yǔ)簡(jiǎn)稱簡(jiǎn)稱說明說明精選文檔簡(jiǎn)稱簡(jiǎn)稱說明說明POIPosition of Interest GPSGlobal Position

4、 SystemTable 1-2 術(shù)語(yǔ)術(shù)語(yǔ)術(shù)語(yǔ)定義定義軟件配置項(xiàng) 為獨(dú)立的配置管理而設(shè)計(jì)的、能滿足最終用戶要求的一組軟件。TCP網(wǎng)絡(luò)傳輸協(xié)議2 參考資料參考資料參考資料可以是公司內(nèi)部文檔,也可以是外部文檔標(biāo)準(zhǔn)或者網(wǎng)站鏈接.如果網(wǎng)站連接被引用,需要給出鏈接的URL 名稱編制單位編制時(shí)間設(shè)計(jì)需求規(guī)格說明書_Ver8.1_2012_03_182017_04_183 交付需求列表交付需求列表列出本次開發(fā)要交付的需求，包括新增的需求，從歷史版本集成的需求等4 系統(tǒng)物理架構(gòu)系統(tǒng)物理架構(gòu)4.1 系統(tǒng)運(yùn)行的硬件環(huán)境系統(tǒng)運(yùn)行的硬件環(huán)境使用表格列出系統(tǒng)的硬件環(huán)境。如果客戶已經(jīng)購(gòu)買了硬件，該處列出即可。如果是產(chǎn)品，

5、該處給精選文檔出推薦配置。列舉系統(tǒng)涉及到得第三方廠商的硬件，比如視頻設(shè)備等名稱名稱型號(hào)型號(hào)備注備注服務(wù)器CPU志強(qiáng)雙核 3000服務(wù)器內(nèi)存16G服務(wù)器存儲(chǔ)4T服務(wù)器硬盤320G服務(wù)器網(wǎng)絡(luò)千兆網(wǎng)客戶端CPUP3 800最低客戶端內(nèi)存256M最低網(wǎng)絡(luò)百兆網(wǎng)共享4.2 系統(tǒng)運(yùn)行的軟件環(huán)境系統(tǒng)運(yùn)行的軟件環(huán)境使用表格列出系統(tǒng)的軟件環(huán)境。包括操作系統(tǒng)，數(shù)據(jù)庫(kù)等信息名稱名稱版本號(hào)版本號(hào)備注備注服務(wù)器操作系統(tǒng)windows 2008server需要提前預(yù)研手寫控件的支持問題服務(wù)器數(shù)據(jù)庫(kù)Oracle9i客戶端操作系統(tǒng)Windows2000、xp、Vista、7客戶端瀏覽器IE6、IE7客戶端OfficeOffi

6、ce2000、xp、2003、20074.3 系統(tǒng)運(yùn)行的網(wǎng)絡(luò)環(huán)境系統(tǒng)運(yùn)行的網(wǎng)絡(luò)環(huán)境描述網(wǎng)絡(luò)帶寬，城域、廣域、局域，網(wǎng)絡(luò)穩(wěn)定性等情況如，各法院間，是2M城域連接，網(wǎng)絡(luò)情況較穩(wěn)定。每月會(huì)出現(xiàn)1-2次斷網(wǎng)，同時(shí)在使用視頻會(huì)議時(shí)，會(huì)限制其他網(wǎng)絡(luò)應(yīng)用。4.4 系統(tǒng)部署圖系統(tǒng)部署圖畫出系統(tǒng)部署圖精選文檔 deployment HO Server ImagesDMZLANHOFW :WatchGuard III FirewallsecureFRR01 :Intel 19510 Frame Relay RouterHOES01 :Ethernet Switched HubWeb Server :Dell Po

7、werEdge 2650pc server RAM = 2 x 1024 MBProcessor = 2 x 2.8 GHZ Disks = 4 x 80 GBDisk Controller = RAID 5HOES02 :Ethernet Switched Hub216.239.46.96 :Ethernet AdaptorMail Server :HP ProLiant DL380pc server RAM = 2048 MbProcessor = 3.0 GhzDisks = 4Disk Controller = RAID 5192.168.0.2 :Ethernet AdaptorWe

8、bDataServer :Dell PowerEdge 6650pc server RAM = 1024 MbProcessor = 3.0 GHzDisks = 3 x 120 GBDisk Controller = RAID 5216.239.46.95 :Ethernet Adaptor192.168.0.3 :Ethernet AdaptorClient Data Server :Dell PowerEdge 1650user pc Processor = 3.0 GHZRAM = 1024 MBDisks = 4 x 120 GBDisk Controller = RAID 5+In

9、ternet+LAN+DMZ4.5 安裝部署說明安裝部署說明使用表格表格說明哪些程序應(yīng)部署在哪臺(tái)計(jì)算機(jī)上精選文檔5 系統(tǒng)系統(tǒng)邏輯架構(gòu)邏輯架構(gòu)使用線框圖，畫出系統(tǒng)的組成架構(gòu)，要求分清系統(tǒng)層次，盡可能的詳細(xì)5.1 子系統(tǒng)子系統(tǒng)一一簡(jiǎn)單描述子系統(tǒng)的功能，在系統(tǒng)中所處的位置、作用等。1.1.1子模塊子模塊一一1.1.1.1用例用例此處要求系統(tǒng)用用例圖表述（UML）1.1.1.2類圖類圖給出該子模塊相關(guān)的類圖1.1.1.3交互圖交互圖給出該子模塊相關(guān)的交互圖1.1.2子模塊二子模塊二1.1.2.1用例用例此處要求系統(tǒng)用用例圖表述（UML）1.1.2.2類圖類圖給出該子模塊相關(guān)的類圖1.1.2.3交互圖交

10、互圖給出該子模塊相關(guān)的交互圖5.2 子系統(tǒng)二子系統(tǒng)二6 實(shí)現(xiàn)視圖實(shí)現(xiàn)視圖代碼目錄、包、jar結(jié)構(gòu)、頁(yè)面目錄規(guī)則精選文檔7 進(jìn)程視圖進(jìn)程視圖總體描述，具體解決措施可在子系統(tǒng)設(shè)計(jì)中描述性能上的考慮，如：高并發(fā)、大數(shù)據(jù)量等性能瓶頸的預(yù)估，應(yīng)對(duì)策略，具體的解決辦法要標(biāo)明參見XX文檔的XX章節(jié)分析性能對(duì)整體框架，技術(shù)路線的影響8 數(shù)據(jù)庫(kù)設(shè)計(jì)數(shù)據(jù)庫(kù)設(shè)計(jì)描述數(shù)據(jù)庫(kù)的邏輯(表結(jié)構(gòu))與物理設(shè)計(jì)(表空間,存儲(chǔ))9 設(shè)計(jì)約束設(shè)計(jì)約束描述系統(tǒng)設(shè)計(jì)中最主要的約束，這些是由客戶強(qiáng)制要求并在需求說明書寫明的。說明系統(tǒng)是如何來適應(yīng)這些約束的。另外如果本系統(tǒng)跟其它外部系統(tǒng)交互或者依賴其它外部系統(tǒng)提供一些功能輔助，那么系統(tǒng)可能還

11、受到其它的約束。這種情況下，要求清楚地描述與本系統(tǒng)有交互的軟件類型（比如某某某數(shù)據(jù)庫(kù)軟件，某某某EMail軟件）以及這樣導(dǎo)致的約束（比如只允許純文本的Email） 。實(shí)現(xiàn)的語(yǔ)言和平臺(tái)也會(huì)對(duì)系統(tǒng)有約束，同樣在此予以說明。對(duì)于因選擇具體的設(shè)計(jì)實(shí)現(xiàn)而導(dǎo)致對(duì)系統(tǒng)的約束，簡(jiǎn)要地描述你的想法思路，經(jīng)過怎么樣的權(quán)衡，為什么要采取這樣的設(shè)計(jì)等等。10 內(nèi)部接口定義內(nèi)部接口定義定義系統(tǒng)內(nèi)部各子系統(tǒng)之間的接口/協(xié)議11 外部接口外部接口側(cè)重于與其他系統(tǒng)之間數(shù)據(jù)交互的描述。包括數(shù)據(jù)的格式，使用的協(xié)議等等精選文檔該處主要描述與其他系統(tǒng)間的接口，如：第三方軟件、公司其他相關(guān)信息化如辦公、辦案等系統(tǒng)；盡可能覆蓋到所有的對(duì)

12、外接口。12 開發(fā)環(huán)境說明開發(fā)環(huán)境說明使用表格列出系統(tǒng)的軟件環(huán)境。包括操作系統(tǒng)，數(shù)據(jù)庫(kù)，使用中間件等信息。目的是約束從代碼到可執(zhí)行程序的過程名稱名稱版本號(hào)版本號(hào)備注備注IDEeclipse3.2JDKjdk1.5中間件tomcat 5.013 技術(shù)難點(diǎn)技術(shù)難點(diǎn)分段列出難點(diǎn)、對(duì)難點(diǎn)的分析，以及應(yīng)對(duì)的策略技術(shù)難點(diǎn)分析說明應(yīng)對(duì)策略節(jié)點(diǎn)承載能力建議的方案對(duì)終端進(jìn)行了負(fù)載均衡，使得服務(wù)器節(jié)點(diǎn)可以復(fù)制支持更多終端，但每一個(gè)終端的信息都通過服務(wù)節(jié)點(diǎn)同步到其他 n-1 個(gè)服務(wù)器節(jié)點(diǎn)，相當(dāng)于將均衡的后的終端信息匯聚到了單一節(jié)點(diǎn)，相當(dāng)于單一節(jié)點(diǎn)承載了所有節(jié)點(diǎn)的壓力。采用 Proxy 模式，減少同步節(jié)點(diǎn)的數(shù)量，代價(jià)是需要增加proxy 模式的相關(guān)開發(fā)Buffer 數(shù)據(jù)一致性由于一個(gè)節(jié)點(diǎn)的數(shù)據(jù)需要