軟件概要設計說明書范例

綱要設計說明書擬制某某某日期2018年10月20日審查日期同意日期文檔改正記錄修他日期版本/狀態(tài)作者改正章節(jié)改正描繪2017-10-17某某某第一版公布填寫說明系統(tǒng)構造的定義本系統(tǒng)對整個軟件系統(tǒng)按以下構造方式進行區(qū)分：系統(tǒng)子系統(tǒng)模塊子模塊此中：（1）“系統(tǒng)子系統(tǒng)”區(qū)分屬于“系統(tǒng)設計”，在系統(tǒng)設計說明書中予以描繪。（2）“子系統(tǒng)模塊”區(qū)分屬于“綱要設計”，在本說明書中予以描繪。（3）“模塊子模塊”區(qū)分屬于“詳盡設計”，在詳盡設計說明書中予以描繪。假如系統(tǒng)相對簡單，能夠省略“子模塊”這一層次。2.假如填寫了系統(tǒng)設計說明書，則在本說明書中掠過“系統(tǒng)子系統(tǒng)”區(qū)分的有關內(nèi)容（即第2章）。3.假如系統(tǒng)相對簡單，不需要做“系統(tǒng)子系統(tǒng)”區(qū)分，這類狀況下，撤消填寫系統(tǒng)設計說明書，只須填寫本說明書，直接套用“子系統(tǒng)模塊”區(qū)分（即第3章）進行“系統(tǒng)模塊”區(qū)分（把此中“子系統(tǒng)”一詞替代為“系統(tǒng)”），并刪除本說明書中“系統(tǒng)子系統(tǒng)”區(qū)分的有關內(nèi)容（第2章）。目錄簡介錯誤!不決義書簽。.背景和目的錯誤!不決義書簽。.范圍錯誤!不決義書簽。.術語和縮略語錯誤!不決義書簽。系統(tǒng)整體設計錯誤!不決義書簽。.任務概括錯誤!不決義書簽。目標錯誤!不決義書簽。需求概括錯誤!不決義書簽。.設計概括錯誤!不決義書簽。整體拘束錯誤!不決義書簽。系統(tǒng)外面接口錯誤!不決義書簽。設計方案概括錯誤!不決義書簽。.系統(tǒng)架構設計錯誤!不決義書簽。系統(tǒng)的邏輯架構設計錯誤!不決義書簽。系統(tǒng)的物理架構設計錯誤!不決義書簽。.子系統(tǒng)定義錯誤!不決義書簽。子系統(tǒng)列表錯誤!不決義書簽。子系統(tǒng)間關系錯誤!不決義書簽。子系統(tǒng)1設計錯誤!不決義書簽。.任務概括錯誤!不決義書簽。目標錯誤!不決義書簽。需求概括錯誤!不決義書簽。.設計概括錯誤!不決義書簽。整體拘束錯誤!不決義書簽。子系統(tǒng)外面接口錯誤!不決義書簽。設計方案概括錯誤!不決義書簽。.子系統(tǒng)架構設計錯誤!不決義書簽。.模塊定義錯誤!不決義書簽。模塊列表錯誤!不決義書簽。模塊間關系錯誤!不決義書簽。模塊描繪錯誤!不決義書簽。4.非功能性需求的實現(xiàn)方案錯誤!不決義書簽。.性能的考慮錯誤!不決義書簽。.兼容性的考慮錯誤!不決義書簽。.安全的考慮錯誤!不決義書簽。.可移植性的考慮錯誤!不決義書簽。.集成與測試的考慮錯誤!不決義書簽。.可擴展性的考慮錯誤!不決義書簽。.靠譜性的考慮錯誤!不決義書簽。.可保護性的考慮錯誤!不決義書簽。5.難點及解決方案錯誤!不決義書簽。參照資料錯誤!不決義書簽。附錄錯誤!不決義書簽。簡介背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設計考慮，包含軟件系統(tǒng)的基本辦理流程，軟件系統(tǒng)的組織構造、模塊區(qū)分、功能分派、接口設計、運轉設計、數(shù)據(jù)構造設計和犯錯辦理設計等，為軟件的詳盡設計確立基礎。范圍本文檔合用于信息推送項目二期產(chǎn)品的服務端。術語和縮略語縮略語英文全名中文解說XMPPTheExtensibleMessagingandPresenceProtocol可擴展通信和表示協(xié)議系統(tǒng)整體設計{裁剪說明：假如已編寫系統(tǒng)設計說明書，或項目不做“系統(tǒng)子系統(tǒng)”區(qū)分，此章省略；不然內(nèi)部的各節(jié)一定按要求填寫。}{“系統(tǒng)──>子系統(tǒng)”區(qū)分。}{目的：1）設計系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯構造、物理構造；2）子系統(tǒng)的區(qū)分與依靠關系定義、子系統(tǒng)之間的接口定義、子系統(tǒng)功能定義。}任務概括目標實現(xiàn)目標和功能。需求概括參照“軟件需求規(guī)格說明書。設計概括整體拘束系統(tǒng)外面接口設計方案概括成立一套即時通信&信息推送的解決方案：云端運用spring+mina+jgroups成立一個散布式的服務端系統(tǒng)，以XMPP協(xié)議供給接口；終端運用smack成立一個XMPP協(xié)議的客戶端，調(diào)用協(xié)議接口實現(xiàn)信息接收和終端展現(xiàn)。系統(tǒng)架構設計系統(tǒng)的邏輯架構設計單IDC服務器架構圖分六層構造：負載平衡層、接入層、邏輯辦理層、數(shù)據(jù)接見層、數(shù)據(jù)層、WEB層。負載平衡層：TV終端經(jīng)過域名接見云端，DNS智能分析終端的IP地點讓它連結就近的散發(fā)服務器，從分發(fā)服務器獲得接入服務器列表，而后斷開XMPP連結；接入層：TV終端和接入服務器成立XMPP長連結，創(chuàng)立會話；邏輯辦理層：終端協(xié)議服務器、推送服務器（RS）、統(tǒng)計服務器。終端協(xié)議服務器：終端往接入服務器發(fā)送協(xié)議包，接入服務器轉發(fā)給終端協(xié)議服務器辦理；推送服務器：負責從MQ拿出信息、分析信息（條件體和信息體）、終端在線和離線查問、按各接入服務器有哪些終端登錄把信息包散發(fā)給接入服務器；統(tǒng)計服務器：運用quartz履行準時任務，實現(xiàn)終端每日在線數(shù)、終端每小時在線數(shù)、終端每日激活數(shù)、終端登錄次數(shù)、信息推送結果等統(tǒng)計功能。數(shù)據(jù)接見層：供給數(shù)據(jù)接見組件，如MysqlJDBC接口、jedis緩存接口。供給第三方推送接口，供第三方云端調(diào)用的API，供給單點推送（明信息/暗信息）、條件（地區(qū)+機型）推送、regid推送。數(shù)據(jù)層：Mongodb集群，Mysql數(shù)據(jù)庫（主從+讀寫分別），ActiveMQ信息行列，Redis緩存服務器。WEB層：營運平臺、第三方推送平臺。多IDC服務器架構圖需要整理系統(tǒng)的物理架構設計子系統(tǒng)定義子系統(tǒng)列表子系統(tǒng)編號子系統(tǒng)名稱（表記）1營運平臺子系統(tǒng)第三方推送接口子系2統(tǒng)第三方推送平臺子系3統(tǒng)4推送服務器子系統(tǒng)5后臺任務子系統(tǒng)

功能描繪開發(fā)方式由超級管理員和營運人員使用，供給第三方管理、基礎數(shù)據(jù)、信息管理、運維、統(tǒng)計、自行開發(fā)系統(tǒng)設置、日記查問等功能。供第三方云端調(diào)用的API，供給單點推送（明信息/暗信息）、條件（地區(qū)+機型）推送、自行開發(fā)regid推送。給第三方使用，供給開發(fā)者賬號注冊、應用管理、信息公布、信息推送結果查問等功自行開發(fā)能。云端的一個邏輯服務器，實現(xiàn)從MQ拿出消息、分析信息（條件體和信息體）、終端在自行開發(fā)線和離線查問、按各接入服務器有哪些終端登錄把信息包散發(fā)給接入服務器。云端的后臺任務系統(tǒng)，運用quartz履行準時任務，實現(xiàn)終端每日在線數(shù)、終端每小時在自行開發(fā)線數(shù)、終端每日激活數(shù)、終端登錄次數(shù)、消息推送結果等統(tǒng)計功能。為信息盒子終端供給云端接口，用XMPP協(xié)云端與終端接口：分議。供給獲得接入服務器列表、電視終端獲6發(fā)服務器、接入服務取獨一表記userid、以userid登錄認證、成立自行開發(fā)器、終端協(xié)議服務器會話及長連結、推送信息、反應信息接收和點擊狀況、終端應用激活上報等協(xié)議。在云端用JGroups技術組建一個集群，管理各7云端集群邏輯服務器，實現(xiàn)各成員之間的通信、成員自行開發(fā)狀態(tài)反應、成員列表保護等功能。注：開發(fā)方式可選：采買、外包、自行開發(fā)、復用。子系統(tǒng)間關系{裁剪說明：必填}{明確子系統(tǒng)之間的調(diào)用關系、子系統(tǒng)間的接口（信息、數(shù)據(jù)構造）以及有關子系統(tǒng)之間的共同工作，能夠使用構造圖、（交互）事務圖、信息序列圖、ER圖描繪。}子系統(tǒng)1設計{裁剪說明：必填}{標題上加入子系統(tǒng)的編號及名稱（表記）}{“子系統(tǒng)──>模塊”區(qū)分。}{目的：1）設計子系統(tǒng)整體框架：子系統(tǒng)的邏輯構造；2）模塊的區(qū)分與依靠關系定義、模塊之間的接口定義、模塊功能定義。}任務概括目標{裁剪說明：可選}{說明設計企圖目標（總目標、分期目標）、作用范圍等。}需求概括{裁剪說明：可選}{解說軟件產(chǎn)品將達成或不達成的功能（能夠直接描繪也能夠參照有關文檔）}設計概括整體拘束開發(fā)規(guī)范{裁剪說明：可選。假如已填寫在，此處則略。}（1）編碼商定{規(guī)定代碼系統(tǒng)、模塊之間的接口和命名規(guī)則。}（2）文件商定{規(guī)定子系統(tǒng)的全部配置、日記等文件命名方式與格式。}（3）目錄商定{規(guī)定子系統(tǒng)的目錄構造，包含運轉目錄、源文件目錄、配置目錄、日記目錄、數(shù)據(jù)目錄等。}ＸＸ拘束{裁剪說明：可選。假如已填寫在，此處則略。}{列出對軟件設計有重要影響的系統(tǒng)內(nèi)外面拘束和限制，可選的拘束包含：用戶環(huán)境內(nèi)存或其余資源限制數(shù)據(jù)儲存和散發(fā)需求安全和靠譜性需求性能需求測試和可保護性需求}子系統(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ù)：–哪些數(shù)據(jù)項–數(shù)據(jù)格式–長度–種類頻度（及時/批辦理）數(shù)據(jù)同步體制平臺沒關性按照的標準供給的功能前置條件后置條件}設計方案概括{裁剪說明：必填。假如在“設計概括”中已描繪過的部分，可略。}{描繪內(nèi)容包含：（1）整個設計所采納的方法：面向?qū)ο笤O計仍是構造化設計（2）采納的系統(tǒng)架構：比如MVC架構、N層架構3）使用的相應技術和工具：比如OMT、Rose、Visio4）采納的框架技術的形式5）使用的設計模式：層模式、微內(nèi)核模式、代理模式等6）描繪資源/內(nèi)存分派，F(xiàn)lash資源/文件分派7）描繪哪些模塊采納軟件復用}子系統(tǒng)架構設計{裁剪說明：必填

}{定義子系統(tǒng)的整體邏輯構造，定義模塊區(qū)分以及模塊之間的依靠關系。{能夠采納分層構造描繪怎樣將子系統(tǒng)分解為模塊。}

}{構造描繪能夠使用構造圖、層次分解圖、數(shù)據(jù)流圖，并用文字說明互相間的關系。}{舉例，繪制構造圖以下：擁有繼承等關系的類圖的可使用UML等工具畫出關系圖，以下：}模塊定義模塊列表{裁剪說明：必填}{列舉模塊時，能夠采納表格方式（編號能夠省略）。}模塊編號模塊名稱（表記）功能簡述開發(fā)方式注：開發(fā)方式可選：采買、外包/自行開發(fā)/復用模塊間關系{裁剪說明：必填}{明確模塊之間的調(diào)用關系、模塊間的接口（信息、數(shù)據(jù)構造）以及有關模塊之間的共同工作，如模塊間時序圖，協(xié)作圖，以及系統(tǒng)之間狀態(tài)切換流程圖。}模塊描繪模塊1{標題上加入模塊的編號及名稱（表記）}1）功能描繪{裁剪說明：必填}{說明該模塊具備什么樣的基本功能，以及每個功能之間的互相關系。}2）性能描繪{裁剪說明：必填}{說明對模塊的性能要求，包含精度、時間特征和辦理速度。}3）接口描繪{裁剪說明：必填}{說明與其余模塊的接口，與其余系統(tǒng)或硬件的接口。}{關于接口函數(shù)，能夠采納以下形式描繪：接口1：形式：輸入：輸出：返回：描繪返回什么。描繪：整體描繪該接口實現(xiàn)的目的。}{需要明確的信息包含：（1）輸入項列出模塊每一個輸入項的特征，包含名稱、表記、數(shù)據(jù)的種類和格式、數(shù)據(jù)值的有效范圍、輸入方式、數(shù)目和頻度、輸入介質(zhì)等；能夠是邏輯層面的輸入項，如：圖片資源、媒體流、網(wǎng)絡數(shù)據(jù)等，也能夠是詳細的物理層面的輸入項，如變量1、變量2，等等。2）輸出項列出模塊每一個輸出項的特征，包含名稱、表記、數(shù)據(jù)的種類和格式，數(shù)據(jù)值的有效范圍、輸出方式、數(shù)目和頻度、輸出介質(zhì)等。}4）配置描繪{裁剪說明：可選}{說明該模塊所處的邏輯地點、物理地點，如指明模塊放在哪個應用服務器或客戶端的哪個目錄、哪個文件（庫），或是在數(shù)據(jù)庫內(nèi)部成立的對象。}模塊2{同。}非功能性需求的實現(xiàn)方案{裁剪說明：整章可選}性能的考慮{如：為知足延時、吞吐量等性能，在既定硬件環(huán)境拘束下所采納的設計方案。}兼容性的考慮{對從前版本的兼容，以及光滑升級的考慮。}安全的考慮{如：作為應用軟件，在安全方面更多的是考慮接見控制，包含使用什么樣的權限管理、分派、考證方案。}可移植性的考慮{系統(tǒng)假如有跨平臺的需求，要考慮操作系統(tǒng)、中間件、應用服務器特征、數(shù)據(jù)庫及第三方服務移植。描述怎樣在不一樣的平臺移植，能否為可配置的}集成與測試的考慮{各個子系統(tǒng)以及模塊以什么先后序次進行開發(fā)、集成（組裝）和測試，即是采納自底向上法仍是自頂向下法。}可擴展性的考慮{不單有對系統(tǒng)功能擴展的設計考慮，還要考慮系統(tǒng)的性能擴展，即可伸縮性。即考慮：（1）怎樣最低成當?shù)卦鎏硇碌墓δ埽?）怎樣最低成本的復制一個新系統(tǒng)，而且新舊系統(tǒng)能夠做成一致體}靠譜性的考慮{對故障檢測、故障隔絕、故障恢復、容錯、冗余、備份的設計考慮。}可保護性的考慮{內(nèi)容應波及：1）系統(tǒng)模塊能否能夠裝置功能模塊能否能夠配置整個系統(tǒng)能否已經(jīng)參數(shù)化2）供給什么樣的保護方式、接口及介面