軟件概要設(shè)計說明書范例

精品文檔XX概要設(shè)計說明書擬制某某某日期2018年10月20日審核日期批準(zhǔn)日期精品文檔文檔修改記錄修改日期版本/狀態(tài)作者修改章節(jié)修改描述2017-10-17V1.0某某某初版V1.0發(fā)布精品文檔填寫說明1.系統(tǒng)結(jié)構(gòu)的定義本體系對整個軟件系統(tǒng)按如下結(jié)構(gòu)方式進行劃分：系統(tǒng)少子系統(tǒng)少模塊少子模塊其中：（1）“系統(tǒng)少子系統(tǒng)”劃分屬于“系統(tǒng)設(shè)計”，在系統(tǒng)設(shè)計說明書中予以描述。（2）“子系統(tǒng)少模塊”劃分屬于“概要設(shè)計”，在本說明書中予以描述。（3）“模塊少子模塊”劃分屬于“詳細設(shè)計”，在詳細設(shè)計說明書中予以描述。如果系統(tǒng)相對簡單，可以省略“子模塊”這一層次。.如果填寫了系統(tǒng)設(shè)計說明書，則在本說明書中略過“系統(tǒng)少子系統(tǒng)”劃分的相關(guān)內(nèi)容（即第2章）。.如果系統(tǒng)相對簡單，不需要做“系統(tǒng)少子系統(tǒng)”劃分，這種情況下，取消填寫系統(tǒng)設(shè)計說明書，只須填寫本說明書，直接套用“子系統(tǒng)少模塊”劃分（即第3章）進行“系統(tǒng)少模塊”劃分（把其中“子系統(tǒng)”一詞替換為“系統(tǒng)”），并刪除本說明書中“系統(tǒng)少子系統(tǒng)”劃分的相關(guān)內(nèi)容（第2章）。精品文檔TOC\o"1-5"\h\z\o"CurrentDocument".簡介 1\o"CurrentDocument"背景和目的 1\o"CurrentDocument"范圍 1\o"CurrentDocument"術(shù)語和縮略語 1\o"CurrentDocument".系統(tǒng)總體設(shè)計 1\o"CurrentDocument"任務(wù)概述 2\o"CurrentDocument"目標(biāo) 2\o"CurrentDocument"需求概述 2\o"CurrentDocument"設(shè)計概述 2\o"CurrentDocument"總體約束 2\o"CurrentDocument"系統(tǒng)外部接口 2\o"CurrentDocument"設(shè)計方案概述 2\o"CurrentDocument"系統(tǒng)架構(gòu)設(shè)計 3\o"CurrentDocument"系統(tǒng)的邏輯架構(gòu)設(shè)計 3\o"CurrentDocument"系統(tǒng)的物理架構(gòu)設(shè)計 5\o"CurrentDocument"子系統(tǒng)定義 5\o"CurrentDocument"子系統(tǒng)列表 5\o"CurrentDocument"子系統(tǒng)間關(guān)系 6\o"CurrentDocument".子系統(tǒng)1設(shè)計 6\o"CurrentDocument"任務(wù)概述 7\o"CurrentDocument"目標(biāo) 7\o"CurrentDocument"需求概述 7\o"CurrentDocument"設(shè)計概述 7總體約束 7子系統(tǒng)外部接口 8設(shè)計方案概述 9\o"CurrentDocument"子系統(tǒng)架構(gòu)設(shè)計 9\o"CurrentDocument"模塊定義 1.1精品文檔TOC\o"1-5"\h\z模塊列表 1.1\o"CurrentDocument"模塊間關(guān)系 11\o"CurrentDocument"模塊描述 11\o"CurrentDocument".非功能性需求的實現(xiàn)方案 13\o"CurrentDocument"性能的考慮 13\o"CurrentDocument"兼容性的考慮 13\o"CurrentDocument"安全的考慮 13\o"CurrentDocument"可移植性的考慮 13\o"CurrentDocument"集成與測試的考慮 13\o"CurrentDocument"可擴展性的考慮 14\o"CurrentDocument"可靠性的考慮 14\o"CurrentDocument"可維護性的考慮 14\o"CurrentDocument".難點及解決方案 14\o"CurrentDocument".參考資料 15\o"CurrentDocument".附錄 15精品文檔1.簡介背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設(shè)計考慮，包括軟件系統(tǒng)的基本處理流程，軟件系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計、運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為軟件的詳細設(shè)計奠定基礎(chǔ)。范本文檔適用于消息推送項目二期產(chǎn)品的服務(wù)端。術(shù)語和縮略語縮略語英文全名中文解釋XMPPTheExtensibleMessagingandPresenceProtocol可擴展通訊和表示協(xié)議2,系統(tǒng)總體設(shè)計｛裁剪說明：如果已編寫系統(tǒng)設(shè)計說明書，或項目不做“系統(tǒng) 子系統(tǒng)”劃分，此章省略；否則內(nèi)部的各節(jié)必須按要求填寫。｝｛“系統(tǒng)——>子系統(tǒng)”劃分。｝｛目的：1）設(shè)計系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯結(jié)構(gòu)、物理結(jié)構(gòu)；2）子系統(tǒng)的劃分與依賴關(guān)系定義、子系統(tǒng)之間的接口定義、子系統(tǒng)功能定義。｝精品文檔任務(wù)概述目標(biāo)實現(xiàn)目標(biāo)和功能。需求概述參考”軟件需求規(guī)格說明書V1.0.doc”。設(shè)計概述2?2.1.總體約束系統(tǒng)外部接口設(shè)計方案概述建立一套即時通訊&消息推送的解決方案：1）云端運用spring+mina+jgroups建立一個分布式的服務(wù)端系統(tǒng)，以XMPP協(xié)議提供接口；2）終端運用smack建立一個XMPP協(xié)議的客戶端，調(diào)用協(xié)議接口實現(xiàn)消息接收和終端展示。精品文檔系統(tǒng)架構(gòu)設(shè)計系統(tǒng)的邏輯架構(gòu)設(shè)計2?3?1.1.單IDC服務(wù)器架構(gòu)圖WEB.L：建靖口設(shè)愎務(wù)器批總眼外器山中統(tǒng)；.唱舞圖 甯桿.服外器式MPP增勢總統(tǒng)WEB.L：建靖口設(shè)愎務(wù)器批總眼外器山中統(tǒng)；.唱舞圖 甯桿.服外器式MPP增勢總統(tǒng)分六層結(jié)構(gòu)：負載均衡層、接入層、邏輯處理層、數(shù)據(jù)訪問層、數(shù)據(jù)層、WEB層。接入網(wǎng)分路（Nb）分發(fā)服為爵［DS）生群網(wǎng)絡(luò)JgM網(wǎng)1）負載均衡層：TV終端通過域名訪問云端，DNS智能解析終端的IP地址讓它連接就近的分發(fā)服務(wù)器，從分發(fā)服務(wù)器獲取接入服務(wù)器列表，然后斷開XMPP連接；2）接入層：TV終端和接入服務(wù)器建立XMPP長連接，創(chuàng)建會話；3）邏輯處理層：終端協(xié)議服務(wù)器、推送服務(wù)器（RS）、統(tǒng)計服務(wù)器。a）終端協(xié)議服務(wù)器：終端往接入服務(wù)器發(fā)送協(xié)議包，接入服務(wù)器轉(zhuǎn)發(fā)給終端協(xié)議服務(wù)器處理；b）推送服務(wù)器：負責(zé)從MQ取出消息、解析消息（條件體和消息體）、終端在線和離線查精品文檔詢、按各接入服務(wù)器有哪些終端登錄把消息包分發(fā)給接入服務(wù)器；c）統(tǒng)計服務(wù)器：運用quartz執(zhí)行定時任務(wù)，實現(xiàn)終端每天在線數(shù)、終端每小時在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計功能。4）數(shù)據(jù)訪問層：提供數(shù)據(jù)訪問組件，如MysqlJDBC接口、jedis緩存接口。提供第三方推送接□，供第三方云端調(diào)用的API，提供單點推送（明消息/暗消息）、條件（區(qū)域+機型）推送、regid推送。5）數(shù)據(jù)層：Mongodb集群，Mysql數(shù)據(jù)庫（主從+讀寫分離），ActiveMQ消息隊列，Redis緩存服務(wù)器。WEB層：運營平臺、第三方推送平臺。2?3?1.2.多IDC服務(wù)器架構(gòu)圖需要整理精品文檔系統(tǒng)的物理架構(gòu)設(shè)計IDC1子系統(tǒng)定義2.4.1,子系統(tǒng)列表子系統(tǒng)編號子系統(tǒng)名稱（標(biāo)識）功能描述開發(fā)方式1運營平臺子系統(tǒng)由超級管理員和運營人員使用，提供第二方管理、基礎(chǔ)數(shù)據(jù)、消息管理、運維、統(tǒng)計、系統(tǒng)設(shè)置、日志查詢等功能。自行開發(fā)2第二方推送接口子系統(tǒng)供第二方云端調(diào)用的API，提供單點推送（明消息/暗消息）、條件（區(qū)域+機型）推送、regid推送。自行開發(fā)3第二方推送平臺子系統(tǒng)給第二方使用，提供開發(fā)者賬號注冊、應(yīng)用管理、消息發(fā)布、消息推送結(jié)果查詢等功能。自行開發(fā)

精品文檔4推送服務(wù)器子系統(tǒng)云端的一個邏輯服務(wù)器，實現(xiàn)從MQ取出消息、解析消息（條件體和消息體）、終端在線和離線查詢、按各接入服務(wù)器有哪些終端登錄把消息包分發(fā)給接入服務(wù)器。自行開發(fā)5后臺任務(wù)子系統(tǒng)云端的后臺任務(wù)系統(tǒng)，運用quartz執(zhí)行定時任務(wù)，實現(xiàn)終端每天在線數(shù)、終端每小時在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計功能。自行開發(fā)6云端與終端接口：分發(fā)服務(wù)器、接入服務(wù)器、終端協(xié)議服務(wù)器為消息盒子終端提供云端接口，用XMPP協(xié)議。提供獲取接入服務(wù)器列表、電視終端獲取唯一標(biāo)識userid、以userid登錄認證、建立會話及長連接、推送消息、反饋消息接收和點擊情況、終端應(yīng)用激活上報等協(xié)議。自行開發(fā)7云端集群在云端用JGroups技術(shù)組建一個集群，管理各邏輯服務(wù)器，實現(xiàn)各成員之間的通訊、成員狀態(tài)反饋、成員列表維護等功能。自行開發(fā)注：開發(fā)方式可選：采購、外包、自行開發(fā)、復(fù)用。2?4.2.子系統(tǒng)間關(guān)系（裁剪說明：必填｝｛明確子系統(tǒng)之間的調(diào)用關(guān)系、子系統(tǒng)間的接口（消息、數(shù)據(jù)結(jié)構(gòu)）以及相關(guān)子系統(tǒng)之間的協(xié)同工作，可以使用結(jié)構(gòu)圖、（交互）事務(wù)圖、消息序列圖、ER圖描述。｝3.子系統(tǒng)1設(shè)計｛裁剪說明：必填｝｛標(biāo)題上加入子系統(tǒng)的編號及名稱（標(biāo)識）｝｛“子系統(tǒng)——>模塊”劃分。｝｛目的：1）設(shè)計子系統(tǒng)整體框架：子系統(tǒng)的邏輯結(jié)構(gòu)；2）模塊的劃分與依賴關(guān)系定義、模塊之間的接口定義、模塊功能定義。｝精品文檔任務(wù)概述目標(biāo)（裁剪說明：可選｝｛說明設(shè)計意圖目標(biāo)（總目標(biāo)、分期目標(biāo)）、作用范圍等。｝需求概述｛裁剪說明：可選｝｛解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關(guān)文檔）｝設(shè)計概述3?2.1.總體約束開發(fā)規(guī)范｛裁剪說明：可選。如果已填寫在,此處則略。｝（1）編碼約定｛規(guī)定代碼體系、模塊之間的接口和命名規(guī)則。｝（2）文件約定｛規(guī)定子系統(tǒng)的所有配置、日志等文件命名方式與格式。｝（3）目錄約定｛規(guī)定子系統(tǒng)的目錄結(jié)構(gòu)，包括運行目錄、源文件目錄、配置目錄、日志目錄、數(shù)據(jù)目錄等。｝精品文檔XX約束｛裁剪說明：可選。如果已填寫在,此處則略。｝｛列出對軟件設(shè)計有重要影響的系統(tǒng)內(nèi)外部約束和限制，可選的約束包括：用戶環(huán)境內(nèi)存或其它資源限制數(shù)據(jù)存儲和分發(fā)需求安全和可靠性需求性能需求測試和可維護性需求｝.2.2.子系統(tǒng)外部接口｛裁剪說明：如果第2章已刪除，這里必填（如果有）。｝｛描述該軟件子系統(tǒng)與外部實體的接口，包括用戶界面、軟件接口、硬件接口和通信接口。｝｛軟件子系統(tǒng)的外部實體，包括：操作系統(tǒng)、驅(qū)動程序、硬件、中斷、其它軟件子系統(tǒng)等。｝｛描述待開發(fā)軟件子系統(tǒng)與外部實體的關(guān)系，可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事務(wù)圖等來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系，并標(biāo)示出外部實體和本系統(tǒng)相互作用的性質(zhì)（比如：消息、庫調(diào)用）和類型（比如：OS服務(wù)、通信服務(wù)、系統(tǒng)工具等）。｝｛詳細描述子系統(tǒng)外部接口的參數(shù)，如：接口名稱調(diào)用方式傳輸?shù)臄?shù)據(jù)：哪些數(shù)據(jù)項？數(shù)據(jù)格式？長度？類型？頻度（實時/批處理）數(shù)據(jù)同步機制平臺無關(guān)性遵循的標(biāo)準(zhǔn)精品文檔提供的功能前置條件后置條件｝設(shè)計方案概述｛裁剪說明：必填。如果在“3.1設(shè)計概述”中已描述過的部分，可略。｝｛描述內(nèi)容包括：（1）整個設(shè)計所采用的方法：面向?qū)ο笤O(shè)計還是結(jié)構(gòu)化設(shè)計（2）采用的系統(tǒng)架構(gòu)：例如MVC架構(gòu)、N層架構(gòu)（3）使用的相應(yīng)技術(shù)和工具：例如OMT、Rose、Visio（4）采用的框架技術(shù)的形式（5）使用的設(shè)計模式：層模式、微內(nèi)核模式、代理模式等（6）描述資源/內(nèi)存分配，F(xiàn)lash資源/文件分配（7）描述哪些模塊采用軟件復(fù)用｝子系統(tǒng)架構(gòu)設(shè)計｛裁剪說明：必填｝｛定義子系統(tǒng)的總體邏輯結(jié)構(gòu)，定義模塊劃分以及模塊之間的依賴關(guān)系。｝｛可以采用分層結(jié)構(gòu)描述如何將子系統(tǒng)分解為模塊。｝｛結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖、層次分解圖、數(shù)據(jù)流圖，并用文字說明相互間的關(guān)系。｝｛舉例，繪制結(jié)構(gòu)圖如下：精品文檔具有繼承等關(guān)系的類圖的可使用UML等工具畫出關(guān)系圖，如下:ccm.tcl.cornman.csharecom.tel.C'Crnmon.cshare.widgetccm.tcl.cornman.cshareLoginActlvityBaseTabActivitycom.tel.eommon.eshare,htitpMyHlomieActivityWelboCcrutentActMmon,csh^mon,csh^re.dbPastWeiboActivityMySpaceActivitycom,tcl.cQmirriion?g專hare,dmeem?teLcomimonBcshareaexeeptioneem?teLcomimonBcshareaexeeptionweiboAandlroidsoweiedbyst精品文檔模塊定義3?4?1,模塊列表（裁剪說明：必填｝｛列舉模塊時，可以采用表格方式（編號可以省略）。｝模塊編號模塊名稱（標(biāo)識）功能簡述開發(fā)方式注：開發(fā)方式可選：采購、外包/自行開發(fā)/復(fù)用模塊間關(guān)系｛裁剪說明：必填｝｛明確模塊之間的調(diào)用關(guān)系、模塊間的接口（消息、數(shù)據(jù)結(jié)構(gòu)）以及相關(guān)模塊之間的協(xié)同工作，如模塊間時序圖，協(xié)作圖，以及系統(tǒng)之間狀態(tài)切換流程圖。｝模塊描述模塊1｛標(biāo)題上加入模塊的編號及名稱（標(biāo)識）｝1）功能描述｛裁剪說明：必填｝｛說明該模塊具備什么樣的基本功能，以及每個功能之間的相互關(guān)系。｝2）性能描述｛裁剪說明：必填｝｛說明對模塊的性能要求，包括精度、時間特性和處理速度。｝精品文檔3）接口描述（裁剪說明：必填｝｛說明與其它模塊的接口，與其它系統(tǒng)或硬件的接口。｝｛對于接口函數(shù)，可以采用以下形式描述：接口1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實現(xiàn)的目的。｝｛需要明確的信息包括：（1）輸入項列出模塊每一個輸入項的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入方式、數(shù)量和頻度、輸入介質(zhì)等；可以是邏輯層面的輸入項，如：圖片資源、媒體流、網(wǎng)絡(luò)數(shù)據(jù)等，也可以是具體的物理層面的輸入項，如變量1、變量2,等等。（2）輸出項列出模塊每一個輸出項的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍、輸出方式、數(shù)量和頻度、輸出介質(zhì)等。｝4）配置描述｛裁剪說明：可選｝｛說明該模塊所處的邏輯位置、物理位置，如指明模塊放在哪個應(yīng)用服務(wù)器或客戶端的哪個目錄、哪個文件（庫），或是在數(shù)據(jù)庫內(nèi)部建立的對象。｝模塊2｛同