軟件概要設計說明書范例

1、.XX概要設計說明書擬制某某某日期2018年10月20日審核日期批準日期文檔修改記錄修改日期版本/狀態(tài)作者修改章節(jié)修改描述2017-10-17V1.0某某某初版V1.0發(fā)布填寫說明1. 系統(tǒng)結構的定義本體系對整個軟件系統(tǒng)按如下結構方式進行劃分：系統(tǒng)子系統(tǒng)模塊子模塊其中：（1）“系統(tǒng) 子系統(tǒng)”劃分屬于“系統(tǒng)設計”，在系統(tǒng)設計說明書中予以描述。（2）“子系統(tǒng) 模塊”劃分屬于“概要設計”，在本說明書中予以描述。（3）“模塊 子模塊”劃分屬于“詳細設計”，在詳細設計說明書中予以描述。如果系統(tǒng)相對簡單，可以省略“子模塊”這一層次。2. 如果填寫了系統(tǒng)設計說明書，則在本說明書中略過“系統(tǒng) 子系統(tǒng)”劃分的相

2、關內(nèi)容（即第2章）。3. 如果系統(tǒng)相對簡單，不需要做“系統(tǒng) 子系統(tǒng)”劃分，這種情況下，取消填寫系統(tǒng)設計說明書，只須填寫本說明書，直接套用“子系統(tǒng) 模塊”劃分（即第3章）進行“系統(tǒng) 模塊”劃分（把其中“子系統(tǒng)”一詞替換為“系統(tǒng)”），并刪除本說明書中“系統(tǒng) 子系統(tǒng)”劃分的相關內(nèi)容（第2章）。目 錄1.簡介11.1.背景和目的11.2.X圍11.3.術語和縮略語12.系統(tǒng)總體設計12.1.任務概述22.1.1.目標22.1.2.需求概述22.2.設計概述22.2.1.總體約束22.2.2.系統(tǒng)外部接口22.2.3.設計方案概述22.3.系統(tǒng)架構設計32.3.1.系統(tǒng)的邏輯架構設計32.3.2.系統(tǒng)的

3、物理架構設計42.4.子系統(tǒng)定義52.4.1.子系統(tǒng)列表52.4.2.子系統(tǒng)間關系53.子系統(tǒng)1設計63.1.任務概述63.1.1.目標63.1.2.需求概述63.2.設計概述63.2.1.總體約束63.2.2.子系統(tǒng)外部接口73.2.3.設計方案概述83.3.子系統(tǒng)架構設計83.4.模塊定義103.4.1.模塊列表103.4.2.模塊間關系113.4.3.模塊描述114.非功能性需求的實現(xiàn)方案126.1.性能的考慮126.2.兼容性的考慮136.3.安全的考慮136.4.可移植性的考慮136.5.集成與測試的考慮136.6.可擴展性的考慮136.7.可靠性的考慮136.8.可維護性的考慮14

4、5.難點及解決方案146.參考資料147.附錄15. v.1. 簡介1.1. 背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設計考慮，包括軟件系統(tǒng)的基本處理流程，軟件系統(tǒng)的組織結構、模塊劃分、功能分配、接口設計、運行設計、數(shù)據(jù)結構設計和出錯處理設計等，為軟件的詳細設計奠定基礎。1.2. X圍本文檔適用于消息推送項目二期產(chǎn)品的服務端。1.3. 術語和縮略語縮略語英文全名中文解釋XMPPThe Extensible Messaging and Presence Protocol可擴展通訊和表示協(xié)議2. 系統(tǒng)總體設計 裁剪說明：如果已編寫系統(tǒng)設計說明書，或項目不做“系統(tǒng) 子系統(tǒng)”劃分，此章省略；否則內(nèi)

5、部的各節(jié)必須按要求填寫?！跋到y(tǒng) 子系統(tǒng)”劃分。 目的：1）設計系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯結構、物理結構；2）子系統(tǒng)的劃分與依賴關系定義、子系統(tǒng)之間的接口定義、子系統(tǒng)功能定義。1.1. 任務概述1.1.1. 目標實現(xiàn)目標和功能。1.1.2. 需求概述參考“軟件需求規(guī)格說明書_V1.0.doc”。1.2. 設計概述1.2.1. 總體約束1.2.2. 系統(tǒng)外部接口1.2.3. 設計方案概述建立一套即時通訊&消息推送的解決方案：1) 云端運用spring+mina+jgroups建立一個分布式的服務端系統(tǒng)，以XMPP協(xié)議提供接口；2) 終端運用smack建立一個XMPP協(xié)議的客戶端，調(diào)用協(xié)議接口

6、實現(xiàn)消息接收和終端展示。1.3. 系統(tǒng)架構設計1.3.1. 系統(tǒng)的邏輯架構設計1.3.1.1. 單IDC服務器架構圖分六層結構：負載均衡層、接入層、邏輯處理層、數(shù)據(jù)訪問層、數(shù)據(jù)層、WEB層。1) 負載均衡層：TV終端通過域名訪問云端，DNS智能解析終端的IP地址讓它連接就近的分發(fā)服務器，從分發(fā)服務器獲取接入服務器列表，然后斷開XMPP連接；2) 接入層：TV終端和接入服務器建立XMPP長連接，創(chuàng)建會話；3) 邏輯處理層：終端協(xié)議服務器、推送服務器（RS）、統(tǒng)計服務器。a) 終端協(xié)議服務器：終端往接入服務器發(fā)送協(xié)議包，接入服務器轉(zhuǎn)發(fā)給終端協(xié)議服務器處理；b) 推送服務器：負責從MQ取出消息、解析

7、消息（條件體和消息體）、終端在線和離線查詢、按各接入服務器有哪些終端登錄把消息包分發(fā)給接入服務器；c) 統(tǒng)計服務器：運用quartz執(zhí)行定時任務，實現(xiàn)終端每天在線數(shù)、終端每小時在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結果等統(tǒng)計功能。4) 數(shù)據(jù)訪問層：提供數(shù)據(jù)訪問組件，如Mysql JDBC接口、jedis緩存接口。提供第三方推送接口，供第三方云端調(diào)用的API，提供單點推送（明消息/暗消息）、條件（區(qū)域+機型）推送、regid推送。5) 數(shù)據(jù)層： Mongodb集群，Mysql數(shù)據(jù)庫（主從+讀寫分離），ActiveMQ消息隊列，Redis緩存服務器。6) WEB層：運營平臺、第三方推送平臺

8、。1.3.1.2. 多IDC服務器架構圖需要整理1.3.2. 系統(tǒng)的物理架構設計1.4. 子系統(tǒng)定義1.4.1. 子系統(tǒng)列表子系統(tǒng)編號子系統(tǒng)名稱（標識）功能描述開發(fā)方式1運營平臺子系統(tǒng)由超級管理員和運營人員使用，提供第三方管理、基礎數(shù)據(jù)、消息管理、運維、統(tǒng)計、系統(tǒng)設置、日志查詢等功能。自行開發(fā)2第三方推送接口子系統(tǒng)供第三方云端調(diào)用的API，提供單點推送（明消息/暗消息）、條件（區(qū)域+機型）推送、regid推送。自行開發(fā)3第三方推送平臺子系統(tǒng)給第三方使用，提供開發(fā)者賬號注冊、應用管理、消息發(fā)布、消息推送結果查詢等功能。自行開發(fā)4推送服務器子系統(tǒng)云端的一個邏輯服務器，實現(xiàn)從MQ取出消息、解析消息（

9、條件體和消息體）、終端在線和離線查詢、按各接入服務器有哪些終端登錄把消息包分發(fā)給接入服務器。自行開發(fā)5后臺任務子系統(tǒng)云端的后臺任務系統(tǒng)，運用quartz執(zhí)行定時任務，實現(xiàn)終端每天在線數(shù)、終端每小時在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結果等統(tǒng)計功能。自行開發(fā)6云端與終端接口：分發(fā)服務器、接入服務器、終端協(xié)議服務器為消息盒子終端提供云端接口，用XMPP協(xié)議。提供獲取接入服務器列表、電視終端獲取唯一標識userid、以userid登錄認證、建立會話及長連接、推送消息、反饋消息接收和點擊情況、終端應用激活上報等協(xié)議。自行開發(fā)7云端集群在云端用JGroups技術組建一個集群，管理各邏輯服務器，

10、實現(xiàn)各成員之間的通訊、成員狀態(tài)反饋、成員列表維護等功能。自行開發(fā)注：開發(fā)方式可選：采購、外包、自行開發(fā)、復用。1.4.2. 子系統(tǒng)間關系 裁剪說明：必填 明確子系統(tǒng)之間的調(diào)用關系、子系統(tǒng)間的接口（消息、數(shù)據(jù)結構）以及相關子系統(tǒng)之間的協(xié)同工作，可以使用結構圖、（交互）事務圖、消息序列圖、ER圖描述。3. 子系統(tǒng)1設計 裁剪說明：必填 標題上加入子系統(tǒng)的編號及名稱（標識）“子系統(tǒng) 模塊”劃分。 目的：1）設計子系統(tǒng)整體框架：子系統(tǒng)的邏輯結構；2）模塊的劃分與依賴關系定義、模塊之間的接口定義、模塊功能定義。1.5. 任務概述1.5.1. 目標 裁剪說明：可選 說明設計意圖目標（總目標、分期目標）、作

11、用X圍等。1.5.2. 需求概述 裁剪說明：可選 解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關文檔）1.6. 設計概述1.6.1. 總體約束1.6.1.1. 開發(fā)規(guī)X 裁剪說明：可選。如果已填寫在2.2.1.1，此處則略。 （1）編碼約定 規(guī)定代碼體系、模塊之間的接口和命名規(guī)則。（2）文件約定 規(guī)定子系統(tǒng)的所有配置、日志等文件命名方式與格式。（3）目錄約定 規(guī)定子系統(tǒng)的目錄結構，包括運行目錄、源文件目錄、配置目錄、日志目錄、數(shù)據(jù)目錄等。1.6.1.2. 約束 裁剪說明：可選。如果已填寫在2.2.2.2，此處則略。列出對軟件設計有重要影響的系統(tǒng)內(nèi)外部約束和限制，可選的約束包括：用

12、戶環(huán)境內(nèi)存或其它資源限制數(shù)據(jù)存儲和分發(fā)需求安全和可靠性需求性能需求測試和可維護性需求1.6.2. 子系統(tǒng)外部接口 裁剪說明：如果第2章已刪除，這里必填（如果有）。 描述該軟件子系統(tǒng)與外部實體的接口，包括用戶界面、軟件接口、硬件接口和通信接口。 軟件子系統(tǒng)的外部實體，包括：操作系統(tǒng)、驅(qū)動程序、硬件、中斷、其它軟件子系統(tǒng)等。 描述待開發(fā)軟件子系統(tǒng)與外部實體的關系，可以使用系統(tǒng)架構圖、頂層數(shù)據(jù)流圖、事務圖等來描述系統(tǒng)結構和交互關系，并標示出外部實體和本系統(tǒng)相互作用的性質(zhì)（比如：消息、庫調(diào)用）和類型（比如：OS服務、通信服務、系統(tǒng)工具等）。 詳細描述子系統(tǒng)外部接口的參數(shù)，如：接口名稱調(diào)用方式傳輸?shù)臄?shù)據(jù)

13、：哪些數(shù)據(jù)項.數(shù)據(jù)格式.長度.類型.頻度（實時/批處理）數(shù)據(jù)同步機制平臺無關性遵循的標準提供的功能前置條件后置條件1.6.3. 設計方案概述 裁剪說明：必填。如果在“3.1設計概述”中已描述過的部分，可略。 描述內(nèi)容包括： （1）整個設計所采用的方法：面向?qū)ο笤O計還是結構化設計（2）采用的系統(tǒng)架構：例如MVC架構、N層架構（3）使用的相應技術和工具：例如OMT、Rose、Visio（4）采用的框架技術的形式（5）使用的設計模式：層模式、微內(nèi)核模式、代理模式等（6）描述資源/內(nèi)存分配，F(xiàn)lash資源/文件分配（7）描述哪些模塊采用軟件復用 1.7. 子系統(tǒng)架構設計 裁剪說明：必填 定義子系統(tǒng)的總

14、體邏輯結構，定義模塊劃分以及模塊之間的依賴關系。 可以采用分層結構描述如何將子系統(tǒng)分解為模塊。 結構描述可以使用結構圖、層次分解圖、數(shù)據(jù)流圖，并用文字說明相互間的關系。 舉例，繪制結構圖如下：具有繼承等關系的類圖的可使用UML等工具畫出關系圖，如下：1.8. 模塊定義3.1.1. 模塊列表 裁剪說明：必填 列舉模塊時，可以采用表格方式（編號可以省略）。模塊編號模塊名稱（標識）功能簡述開發(fā)方式注：開發(fā)方式可選：采購、外包/自行開發(fā)/復用3.1.2. 模塊間關系 裁剪說明：必填 明確模塊之間的調(diào)用關系、模塊間的接口（消息、數(shù)據(jù)結構）以及相關模塊之間的協(xié)同工作，如模塊間時序圖，協(xié)作圖，以及系統(tǒng)之間狀

15、態(tài)切換流程圖。3.1.3. 模塊描述3.1.3.1. 模塊1 標題上加入模塊的編號及名稱（標識）1）功能描述 裁剪說明：必填 說明該模塊具備什么樣的基本功能，以及每個功能之間的相互關系。2）性能描述 裁剪說明：必填 說明對模塊的性能要求，包括精度、時間特性和處理速度。3）接口描述 裁剪說明：必填 說明與其它模塊的接口，與其它系統(tǒng)或硬件的接口。 對于接口函數(shù)，可以采用以下形式描述：接口1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實現(xiàn)的目的。 需要明確的信息包括：（1）輸入項列出模塊每一個輸入項的特性，包括名稱、標識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效X圍、輸入方式、數(shù)量和頻度、輸入

16、介質(zhì)等；可以是邏輯層面的輸入項，如：圖片資源、媒體流、網(wǎng)絡數(shù)據(jù)等，也可以是具體的物理層面的輸入項，如變量1、變量2，等等。（2）輸出項列出模塊每一個輸出項的特性，包括名稱、標識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效X圍、輸出方式、數(shù)量和頻度、輸出介質(zhì)等。4）配置描述 裁剪說明：可選 說明該模塊所處的邏輯位置、物理位置，如指明模塊放在哪個應用服務器或客戶端的哪個目錄、哪個文件（庫），或是在數(shù)據(jù)庫內(nèi)部建立的對象。3.1.3.2. 模塊2 同3.3.3.1。4. 非功能性需求的實現(xiàn)方案 裁剪說明：整章可選 6.1. 性能的考慮 如：為滿足延時、吞吐量等性能，在既定硬件環(huán)境約束下所采取的設計方案。6.2.

17、兼容性的考慮 對以前版本的兼容，以及平滑升級的考慮。6.3. 安全的考慮 如：作為應用軟件，在安全方面更多的是考慮訪問控制，包括使用什么樣的權限管理、分配、驗證方案。6.4. 可移植性的考慮 系統(tǒng)如果有跨平臺的需求，要考慮操作系統(tǒng)、中間件、應用服務器特性、數(shù)據(jù)庫及第三方服務移植。描述如何在不同的平臺移植，是否為可配置的. 6.5. 集成與測試的考慮 各個子系統(tǒng)以及模塊以什么先后次序進行開發(fā)、集成（組裝）和測試，即是采用自底向上法還是自頂向下法。6.6. 可擴展性的考慮 不僅有對系統(tǒng)功能擴展的設計考慮，還要考慮系統(tǒng)的性能擴展，即可伸縮性。即考慮：（1）如何最低成本地添加新的功能.（2）如何最低成本的復制一個新系統(tǒng)，并且新舊系統(tǒng)可以做成統(tǒng)一體.6.7. 可靠性的考慮 對故障檢測、故障隔離、故障恢復、容錯、冗余、備份的設計考慮。6.8. 可維護性的考慮 內(nèi)容應涉及：（1）系統(tǒng)模塊是否可以裝配.功能模塊是否可以配置.整個系統(tǒng)是否已經(jīng)參數(shù)化.（2）提供什么樣的維護方式、接口及