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

1、.1*概要設(shè)計說明書擬 制*日 期2021年10月20日審 核日 期批 準(zhǔn)日 期文檔修改記錄修改日期版本/狀態(tài)作者修改章節(jié)修改描述2021-10-17V1.0*初版V1.0發(fā)布填寫說明1. 系統(tǒng)構(gòu)造的定義本體系對整個軟件系統(tǒng)按如下構(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)相對簡單，可以省略“子模塊這一層次。2. 如果填寫了系統(tǒng)設(shè)計說明書，則在本說明書中略過“系統(tǒng) 子系統(tǒng)劃分的相關(guān)容即第2章。3.

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)容第2章。目 錄 TOC o 1-3 h z u HYPERLINK l _Toc3804225501.簡介 PAGEREF _Toc380422550 h 1HYPERLINK l _Toc3804225511.1.背景和目的 PAGEREF _Toc380422551 h 1HYPERLINK l _Toc3804225521.2.圍 PAGEREF _Toc380

3、422552 h 1HYPERLINK l _Toc3804225531.3.術(shù)語和縮略語 PAGEREF _Toc380422553 h 1HYPERLINK l _Toc3804225562.系統(tǒng)總體設(shè)計 PAGEREF _Toc380422556 h 1HYPERLINK l _Toc3804225572.1.任務(wù)概述 PAGEREF _Toc380422557 h 2HYPERLINK l _Toc3804225582.1.1.目標(biāo) PAGEREF _Toc380422558 h 2HYPERLINK l _Toc3804225592.1.2.需求概述 PAGEREF _Toc3804

4、22559 h 2HYPERLINK l _Toc3804225602.2.設(shè)計概述 PAGEREF _Toc380422560 h 2HYPERLINK l _Toc3804225612.2.1.總體約束 PAGEREF _Toc380422561 h 2HYPERLINK l _Toc3804225622.2.2.系統(tǒng)外部接口 PAGEREF _Toc380422562 h 2HYPERLINK l _Toc3804225632.2.3.設(shè)計方案概述 PAGEREF _Toc380422563 h 2HYPERLINK l _Toc3804225642.3.系統(tǒng)架構(gòu)設(shè)計 PAGEREF _

5、Toc380422564 h 3HYPERLINK l _Toc3804225652.3.1.系統(tǒng)的邏輯架構(gòu)設(shè)計 PAGEREF _Toc380422565 h 3HYPERLINK l _Toc3804225662.3.2.系統(tǒng)的物理架構(gòu)設(shè)計 PAGEREF _Toc380422566 h 4HYPERLINK l _Toc3804225672.4.子系統(tǒng)定義 PAGEREF _Toc380422567 h 5HYPERLINK l _Toc3804225682.4.1.子系統(tǒng)列表 PAGEREF _Toc380422568 h 5HYPERLINK l _Toc3804225692.4.2

6、.子系統(tǒng)間關(guān)系 PAGEREF _Toc380422569 h 5HYPERLINK l _Toc3804225703.子系統(tǒng)1設(shè)計 PAGEREF _Toc380422570 h 6HYPERLINK l _Toc3804225723.1.任務(wù)概述 PAGEREF _Toc380422572 h 6HYPERLINK l _Toc3804225733.1.1.目標(biāo) PAGEREF _Toc380422573 h 6HYPERLINK l _Toc3804225743.1.2.需求概述 PAGEREF _Toc380422574 h 6HYPERLINK l _Toc3804225753.2.

7、設(shè)計概述 PAGEREF _Toc380422575 h 6HYPERLINK l _Toc3804225763.2.1.總體約束 PAGEREF _Toc380422576 h 6HYPERLINK l _Toc3804225773.2.2.子系統(tǒng)外部接口 PAGEREF _Toc380422577 h 7HYPERLINK l _Toc3804225783.2.3.設(shè)計方案概述 PAGEREF _Toc380422578 h 8HYPERLINK l _Toc3804225793.3.子系統(tǒng)架構(gòu)設(shè)計 PAGEREF _Toc380422579 h 8HYPERLINK l _Toc3804

8、225803.4.模塊定義 PAGEREF _Toc380422580 h 10HYPERLINK l _Toc3804225853.4.1.模塊列表 PAGEREF _Toc380422585 h 10HYPERLINK l _Toc3804225863.4.2.模塊間關(guān)系 PAGEREF _Toc380422586 h 11HYPERLINK l _Toc3804225873.4.3.模塊描述 PAGEREF _Toc380422587 h 11HYPERLINK l _Toc3804225884.非功能性需求的實現(xiàn)方案 PAGEREF _Toc380422588 h 12HYPERLIN

9、K l _Toc3804225896.1.性能的考慮 PAGEREF _Toc380422589 h 12HYPERLINK l _Toc3804225906.2.兼容性的考慮 PAGEREF _Toc380422590 h 13HYPERLINK l _Toc3804225916.3.平安的考慮 PAGEREF _Toc380422591 h 13HYPERLINK l _Toc3804225926.4.可移植性的考慮 PAGEREF _Toc380422592 h 13HYPERLINK l _Toc3804225936.5.集成與測試的考慮 PAGEREF _Toc380422593 h

10、 13HYPERLINK l _Toc3804225946.6.可擴展性的考慮 PAGEREF _Toc380422594 h 13HYPERLINK l _Toc3804225956.7.可靠性的考慮 PAGEREF _Toc380422595 h 13HYPERLINK l _Toc3804225966.8.可維護性的考慮 PAGEREF _Toc380422596 h 14HYPERLINK l _Toc3804225975.難點及解決方案 PAGEREF _Toc380422597 h 14HYPERLINK l _Toc3804225986.參考資料 PAGEREF _Toc3804

11、22598 h 14HYPERLINK l _Toc3804225997.附錄 PAGEREF _Toc380422599 h15.1簡介背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設(shè)計考慮，包括軟件系統(tǒng)的根本處理流程，軟件系統(tǒng)的組織構(gòu)造、模塊劃分、功能分配、接口設(shè)計、運行設(shè)計、數(shù)據(jù)構(gòu)造設(shè)計和出錯處理設(shè)計等，為軟件的詳細設(shè)計奠定根底。圍本文檔適用于消息推送工程二期產(chǎn)品的效勞端。術(shù)語和縮略語縮略語英文全名中文解釋*MPPThe E*tensible Messaging and Presence Protocol可擴展通訊和表示協(xié)議系統(tǒng)總體設(shè)計 裁剪說明：如果已編寫系統(tǒng)設(shè)計說明書，或工程不做“系統(tǒng)

12、 子系統(tǒng)劃分，此章省略；否則部的各節(jié)必須按要求填寫?！跋到y(tǒng) 子系統(tǒng)劃分。 目的：1設(shè)計系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯構(gòu)造、物理構(gòu)造；2子系統(tǒng)的劃分與依賴關(guān)系定義、子系統(tǒng)之間的接口定義、子系統(tǒng)功能定義。任務(wù)概述目標(biāo)實現(xiàn)目標(biāo)和功能。需求概述參考“軟件需求規(guī)格說明書。設(shè)計概述總體約束系統(tǒng)外部接口設(shè)計方案概述建立一套即時通訊&消息推送的解決方案：云端運用spring+mina+jgroups建立一個分布式的效勞端系統(tǒng)，以*MPP協(xié)議提供接口；終端運用smack建立一個*MPP協(xié)議的客戶端，調(diào)用協(xié)議接口實現(xiàn)消息接收和終端展示。系統(tǒng)架構(gòu)設(shè)計系統(tǒng)的邏輯架構(gòu)設(shè)計單IDC效勞器架構(gòu)圖分六層構(gòu)造：負載均衡層、接

13、入層、邏輯處理層、數(shù)據(jù)層、數(shù)據(jù)層、WEB層。負載均衡層：TV終端通過域名云端，DNS智能解析終端的IP地址讓它連接就近的分發(fā)效勞器，從分發(fā)效勞器獲取接入效勞器列表，然后斷開*MPP連接；接入層：TV終端和接入效勞器建立*MPP長連接，創(chuàng)立會話；邏輯處理層：終端協(xié)議效勞器、推送效勞器RS、統(tǒng)計效勞器。終端協(xié)議效勞器：終端往接入效勞器發(fā)送協(xié)議包，接入效勞器轉(zhuǎn)發(fā)給終端協(xié)議效勞器處理；推送效勞器：負責(zé)從MQ取出消息、解析消息條件體和消息體、終端在線和離線查詢、按各接入效勞器有哪些終端登錄把消息包分發(fā)給接入效勞器；統(tǒng)計效勞器：運用quartz執(zhí)行定時任務(wù)，實現(xiàn)終端每天在線數(shù)、終端每小時在線數(shù)、終端每天激

14、活數(shù)、終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計功能。數(shù)據(jù)層：提供數(shù)據(jù)組件，如Mysql JDBC接口、jedis緩存接口。提供第三方推送接口，供第三方云端調(diào)用的API，提供單點推送明消息/暗消息、條件區(qū)域+機型推送、regid推送。數(shù)據(jù)層： Mongodb集群，Mysql數(shù)據(jù)庫主從+讀寫別離，ActiveMQ消息隊列，Redis緩存效勞器。WEB層：運營平臺、第三方推送平臺。多IDC效勞器架構(gòu)圖需要整理系統(tǒng)的物理架構(gòu)設(shè)計子系統(tǒng)定義子系統(tǒng)列表子系統(tǒng)編號子系統(tǒng)名稱標(biāo)識功能描述開發(fā)方式1運營平臺子系統(tǒng)由超級管理員和運營人員使用，提供第三方管理、根底數(shù)據(jù)、消息管理、運維、統(tǒng)計、系統(tǒng)設(shè)置、日志查詢等功能。自行開

15、發(fā)2第三方推送接口子系統(tǒng)供第三方云端調(diào)用的API，提供單點推送明消息/暗消息、條件區(qū)域+機型推送、regid推送。自行開發(fā)3第三方推送平臺子系統(tǒng)給第三方使用，提供開發(fā)者賬號注冊、應(yīng)用管理、消息發(fā)布、消息推送結(jié)果查詢等功能。自行開發(fā)4推送效勞器子系統(tǒng)云端的一個邏輯效勞器，實現(xiàn)從MQ取出消息、解析消息條件體和消息體、終端在線和離線查詢、按各接入效勞器有哪些終端登錄把消息包分發(fā)給接入效勞器。自行開發(fā)5后臺任務(wù)子系統(tǒng)云端的后臺任務(wù)系統(tǒng)，運用quartz執(zhí)行定時任務(wù)，實現(xiàn)終端每天在線數(shù)、終端每小時在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計功能。自行開發(fā)6云端與終端接口：分發(fā)效勞器、接入效勞

16、器、終端協(xié)議效勞器為消息盒子終端提供云端接口，用*MPP協(xié)議。提供獲取接入效勞器列表、電視終端獲取唯一標(biāo)識userid、以userid登錄認(rèn)證、建立會話及長連接、推送消息、反響消息接收和點擊情況、終端應(yīng)用激活上報等協(xié)議。自行開發(fā)7云端集群在云端用JGroups技術(shù)組建一個集群，管理各邏輯效勞器，實現(xiàn)各成員之間的通訊、成員狀態(tài)反響、成員列表維護等功能。自行開發(fā)注：開發(fā)方式可選：采購、外包、自行開發(fā)、復(fù)用。子系統(tǒng)間關(guān)系 裁剪說明：必填 明確子系統(tǒng)之間的調(diào)用關(guān)系、子系統(tǒng)間的接口消息、數(shù)據(jù)構(gòu)造以及相關(guān)子系統(tǒng)之間的協(xié)同工作，可以使用構(gòu)造圖、交互事務(wù)圖、消息序列圖、ER圖描述。子系統(tǒng)1設(shè)計 裁剪說明：必填

17、 標(biāo)題上參加子系統(tǒng)的編號及名稱標(biāo)識“子系統(tǒng) 模塊劃分。 目的：1設(shè)計子系統(tǒng)整體框架：子系統(tǒng)的邏輯構(gòu)造；2模塊的劃分與依賴關(guān)系定義、模塊之間的接口定義、模塊功能定義。任務(wù)概述目標(biāo) 裁剪說明：可選 說明設(shè)計意圖目標(biāo)總目標(biāo)、分期目標(biāo)、作用圍等。需求概述 裁剪說明：可選 解釋軟件產(chǎn)品將完成或不完成的功能可以直接描述也可以參考相關(guān)文檔設(shè)計概述總體約束開發(fā)規(guī) 裁剪說明：可選。如果已填寫在2.2.1.1，此處則略。 1編碼約定 規(guī)定代碼體系、模塊之間的接口和命名規(guī)則。2文件約定 規(guī)定子系統(tǒng)的所有配置、日志等文件命名方式與格式。3目錄約定 規(guī)定子系統(tǒng)的目錄構(gòu)造，包括運行目錄、源文件目錄、配置目錄、日志目錄、數(shù)

18、據(jù)目錄等。約束 裁剪說明：可選。如果已填寫在2.2.2.2，此處則略。 列出對軟件設(shè)計有重要影響的系統(tǒng)外部約束和限制，可選的約束包括：用戶環(huán)境存或其它資源限制數(shù)據(jù)存儲和分發(fā)需求平安和可靠性需求性能需求測試和可維護性需求子系統(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)構(gòu)造和交互關(guān)系，并標(biāo)示出外部實體和本系統(tǒng)相互作用的性質(zhì)比方：消息、庫調(diào)

19、用和類型比方：OS效勞、通信效勞、系統(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è)計概述中已描述過的局部，可略。 描述容包括： 1整個設(shè)計所采用的方法：面向?qū)ο笤O(shè)計還是構(gòu)造化設(shè)計2采用的系統(tǒng)架構(gòu)：例如MVC架構(gòu)、N層架構(gòu)3使用的相應(yīng)技術(shù)和工具：例如OMT、Rose、Visio4采用的框架技術(shù)的形式5使用的設(shè)計模式：層模式、微核模式、代理模式等6描述資源/存分配，F(xiàn)lash資源/文件分配7描述哪些模塊采用軟件復(fù)用 子

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

21、流程圖。模塊描述模塊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)用效勞器或客戶端的哪個目錄、哪個文件庫，或是在數(shù)據(jù)庫部建立的對象。模塊2 同3.3.