軟件概要設(shè)計(jì)說(shuō)明書(shū)范例

模板編號(hào)GENWEB模板版本XX概要設(shè)計(jì)說(shuō)明書(shū)擬制某某某日期2018年10月20日審核日期批準(zhǔn)日期模板編號(hào)GENWEB模板版本文檔修改記錄修改日期版本/狀態(tài)作者修改章節(jié)修改描述2017-10-17某某某初版發(fā)布模板編號(hào)GENWEB模板版本填寫說(shuō)明系統(tǒng)結(jié)構(gòu)的定義本體系對(duì)整個(gè)軟件系統(tǒng)按如下結(jié)構(gòu)方式進(jìn)行劃分：系統(tǒng)->子系統(tǒng)->模塊->子模塊其中：〔1〕“系統(tǒng)T子系統(tǒng)”劃分屬于“系統(tǒng)設(shè)計(jì)”，在系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)中予以描述?！?〕“子系統(tǒng)T模塊”劃分屬于“概要設(shè)計(jì)”，在本說(shuō)明書(shū)中予以描述?！?〕“模塊T子模塊”劃分屬于“詳細(xì)設(shè)計(jì)”，在詳細(xì)設(shè)計(jì)說(shuō)明書(shū)中予以描述。如果系統(tǒng)相對(duì)簡(jiǎn)單，可以省略“子模塊”這一層次。如果填寫了系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)，則在本說(shuō)明書(shū)中略過(guò)“系統(tǒng)T子系統(tǒng)”劃分的相關(guān)內(nèi)容〔即第2章〕。如果系統(tǒng)相對(duì)簡(jiǎn)單，不需要做“系統(tǒng)T子系統(tǒng)”劃分，這種情況下，取消填寫系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)，只須填寫本說(shuō)明書(shū)，直接套用“子系統(tǒng)T模塊”劃分〔即第3章〕進(jìn)行“系統(tǒng)T模塊”劃分〔把其中“子系統(tǒng)”一詞替換為“系統(tǒng)”〕，并刪除本說(shuō)明書(shū)中“系統(tǒng)->子系統(tǒng)”劃分的相關(guān)內(nèi)容〔第2章〕。模板編號(hào)GENWEB模板版本目錄TOC\o"1-5"\h\z\o"CurrentDocument"1.簡(jiǎn)介 1\o"CurrentDocument"背景和目的 11.2. 范圍 1\o"CurrentDocument"術(shù)語(yǔ)和縮略語(yǔ) 1\o"CurrentDocument"2.系統(tǒng)總體設(shè)計(jì) 1\o"CurrentDocument"2.1. 任務(wù)概述 2\o"CurrentDocument"目標(biāo) 2\o"CurrentDocument"2.1.2.需求概述 2\o"CurrentDocument"2.2.設(shè)計(jì)概述 2\o"CurrentDocument"2.2.1.總體約束 2\o"CurrentDocument"2.2.2.系統(tǒng)外部接口 2\o"CurrentDocument"2.2.3.設(shè)計(jì)方案概述 2\o"CurrentDocument"系統(tǒng)架構(gòu)設(shè)計(jì) 3\o"CurrentDocument"2.3.1.系統(tǒng)的邏輯架構(gòu)設(shè)計(jì) 32.3.2.系統(tǒng)的物理架構(gòu)設(shè)計(jì) 4\o"CurrentDocument"子系統(tǒng)定義 52.4.1.子系統(tǒng)列表 5\o"CurrentDocument"2.4.2.子系統(tǒng)間關(guān)系 53.子系統(tǒng)1設(shè)計(jì) 6\o"CurrentDocument"3.1.任務(wù)概述 6\o"CurrentDocument"目標(biāo) 6\o"CurrentDocument"3.1.2.需求概述 6\o"CurrentDocument"3.2.設(shè)計(jì)概述 6\o"CurrentDocument"3.2.1.總體約束 6\o"CurrentDocument"子系統(tǒng)外部接口 7\o"CurrentDocument"3.2.3.設(shè)計(jì)方案概述 8\o"CurrentDocument"3.3.子系統(tǒng)架構(gòu)設(shè)計(jì) 8\o"CurrentDocument"3.4.模塊定義 10模板編號(hào)GENWEB模板版本TOC\o"1-5"\h\z3.4.1.模塊列表 10\o"CurrentDocument"3.4.2.模塊間關(guān)系 1..1\o"CurrentDocument"3.4.3.模塊描述 1..1\o"CurrentDocument"非功能性需求的實(shí)現(xiàn)方案 12\o"CurrentDocument"6.1. 性能的考慮 12\o"CurrentDocument"兼容性的考慮 13\o"CurrentDocument"安全的考慮 13\o"CurrentDocument"6.4. 可移植性的考慮 13\o"CurrentDocument"6.5. 集成與測(cè)試的考慮 13\o"CurrentDocument"6.6. 可擴(kuò)展性的考慮 13\o"CurrentDocument"6.7. 可靠性的考慮 13\o"CurrentDocument"6.8. 可維護(hù)性的考慮 14\o"CurrentDocument"5.難點(diǎn)及解決方案 14\o"CurrentDocument"6.參考資料 147.附錄 15模板編號(hào)GENWEB模板版本1.簡(jiǎn)介1.1.背景和目的本文檔編制的目的是說(shuō)明對(duì)軟件系統(tǒng)的設(shè)計(jì)考慮，包括軟件系統(tǒng)的基本處理流程，軟件系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為軟件的詳細(xì)設(shè)計(jì)奠定基礎(chǔ)。1.2.范本文檔適用于消息推送項(xiàng)目二期產(chǎn)品的服務(wù)端。1.3.術(shù)語(yǔ)和縮略語(yǔ)縮略語(yǔ)英文全名中文解釋XMPPTheExtensibleMessagingandPreseneeProtocol可擴(kuò)展通訊和表示協(xié)議2.系統(tǒng)總體設(shè)計(jì){裁剪說(shuō)明：如果已編寫系統(tǒng)設(shè)計(jì)說(shuō)明書(shū)，或項(xiàng)目不做“系統(tǒng)子系統(tǒng)”劃分，此章省略；否則內(nèi)部的各節(jié)必須按要求填寫。}{“系統(tǒng) >子系統(tǒng)”劃分。}{目的：1〕設(shè)計(jì)系統(tǒng)整體框架：系統(tǒng)最高層次的邏輯結(jié)構(gòu)、物理結(jié)構(gòu)；2〕子系統(tǒng)的劃分與依賴關(guān)系定義、子系統(tǒng)之間的接口定義、子系統(tǒng)功能定義。}模板編號(hào)GENWEB模板版本2.1.任務(wù)概述目標(biāo)實(shí)現(xiàn)目標(biāo)和功能。需求概述參考“軟件需求規(guī)格說(shuō)明書(shū)”。設(shè)計(jì)概述2.2.1.總體約束系統(tǒng)外部接口2.2.3.設(shè)計(jì)方案概述建立一套即時(shí)通訊&消息推送的解決方案：1） 云端運(yùn)用spring+mina+jgroups建立一個(gè)分布式的服務(wù)端系統(tǒng)，以XMPP協(xié)議提供接口；2） 終端運(yùn)用smack建立一個(gè)XMPP協(xié)議的客戶端，調(diào)用協(xié)議接口實(shí)現(xiàn)消息接收和終端展示。2?3■系統(tǒng)架構(gòu)設(shè)計(jì)2?3?1?系統(tǒng)的邏輯架構(gòu)設(shè)計(jì)2?3?2?3■系統(tǒng)架構(gòu)設(shè)計(jì)2?3?1?系統(tǒng)的邏輯架構(gòu)設(shè)計(jì)2?3?1?1?單IDC服務(wù)器架構(gòu)圖弟二方推退平臺(tái)AcihcMQ{II?SFllbask：}第=方摧送接口沱汁服舒窖 I版探服停巖【制左&據(jù)對(duì)擲蠱MPP帳外總蛭 模板編號(hào)GENWEB模板版本分六層結(jié)構(gòu)：負(fù)載均衡層、接入層、邏輯處理層、數(shù)據(jù)訪問(wèn)層、數(shù)據(jù)層、WEB層。1） 負(fù)載均衡層：TV終端通過(guò)域名訪問(wèn)云端，DNS智能解析終端的IP地址讓它連接就近的分發(fā)服務(wù)器，從分發(fā)服務(wù)器獲取接入服務(wù)器列表，然后斷開(kāi)XMPP連接；2） 接入層：TV終端和接入服務(wù)器建立XMPP長(zhǎng)連接，創(chuàng)建會(huì)話；3） 邏輯處理層：終端協(xié)議服務(wù)器、推送服務(wù)器〔RS〕、統(tǒng)計(jì)服務(wù)器。a） 終端協(xié)議服務(wù)器：終端往接入服務(wù)器發(fā)送協(xié)議包，接入服務(wù)器轉(zhuǎn)發(fā)給終端協(xié)議服務(wù)器處理；b） 推送服務(wù)器：負(fù)責(zé)從MQ取出消息、解析消息〔條件體和消息體〕、終端在線和離線查詢、按各接入服務(wù)器有哪些終端登錄把消息包分發(fā)給接入服務(wù)器；模板編號(hào)GENWEB模板版本c）統(tǒng)計(jì)服務(wù)器：運(yùn)用quartz執(zhí)行定時(shí)任務(wù)，實(shí)現(xiàn)終端每天在線數(shù)、終端每小時(shí)在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計(jì)功能。4）數(shù)據(jù)訪問(wèn)層：提供數(shù)據(jù)訪問(wèn)組件，如MysqlJDBC接口、jedis緩存接口。提供第三方推送接口，供第三方云端調(diào)用的API，提供單點(diǎn)推送〔明消息/暗消息〕條件〔區(qū)域+機(jī)型〕推送、regid推送。5） 數(shù)據(jù)層：Mongodb集群，Mysql數(shù)據(jù)庫(kù)〔主從+讀寫別離〕，ActiveMQ消息隊(duì)列，Redis緩存服務(wù)器。6） WEB層：運(yùn)營(yíng)平臺(tái)、第三方推送平臺(tái)。2?3?1?2?多IDC服務(wù)器架構(gòu)圖需要整理2?3?2?系統(tǒng)的物理架構(gòu)設(shè)計(jì)IDC1T￥端模板編號(hào)GENWEB模板版本2?4?子系統(tǒng)定義2.4.1.子系統(tǒng)列表子系統(tǒng)編號(hào)子系統(tǒng)名稱〔標(biāo)識(shí)〕功能描述開(kāi)發(fā)方式1運(yùn)呂平臺(tái)子系統(tǒng)由超級(jí)管理員和運(yùn)營(yíng)人員使用，提供第三方管理、基礎(chǔ)數(shù)據(jù)、消息管理、運(yùn)維、統(tǒng)計(jì)、系統(tǒng)設(shè)置、日志查詢等功能。自行開(kāi)發(fā)2第三方推送接口子系統(tǒng)供第三方云端調(diào)用的API，提供單點(diǎn)推送〔明消息/暗消息〕、條件〔區(qū)域+機(jī)型〕推送、regid推送。自行開(kāi)發(fā)3第三方推送平臺(tái)子系統(tǒng)給第三方使用，提供開(kāi)發(fā)者賬號(hào)注冊(cè)、應(yīng)用管理、消息發(fā)布、消息推送結(jié)果查詢等功能。自行開(kāi)發(fā)4推送服務(wù)器子系統(tǒng)云端的一個(gè)邏輯服務(wù)器，實(shí)現(xiàn)從MQ取出消息、解析消息〔條件體和消息體〕、終端在線和離線查詢、按各接入服務(wù)器有哪些終端登錄把消息包分發(fā)給接入服務(wù)器。自行開(kāi)發(fā)5后臺(tái)任務(wù)子系統(tǒng)云端的后臺(tái)任務(wù)系統(tǒng)，運(yùn)用quartz執(zhí)行定時(shí)任務(wù)，實(shí)現(xiàn)終端母天在線數(shù)、終端母小時(shí)在線數(shù)、終端每天激活數(shù)、終端登錄次數(shù)、消息推送結(jié)果等統(tǒng)計(jì)功能。自行開(kāi)發(fā)6云端與終端接口：分發(fā)服務(wù)器、接入服務(wù)器、終端協(xié)議服務(wù)器為消息盒子終端提供云端接口，用XMPP協(xié)議。提供獲取接入服務(wù)器列表、電視終端獲取唯一標(biāo)識(shí)userid、以u(píng)serid登錄認(rèn)證、建立會(huì)話及長(zhǎng)連接、推送消息、反饋消息接收和點(diǎn)擊情況、終端應(yīng)用激活上報(bào)等協(xié)議。自行開(kāi)發(fā)7云端集群在云端用JGroups技術(shù)組建一個(gè)集群，管理各邏輯服務(wù)器，實(shí)現(xiàn)各成員之間的通訊、成員狀態(tài)反饋、成員列表維護(hù)等功能。自行開(kāi)發(fā)注：開(kāi)發(fā)方式可選：采購(gòu)、外包、自行開(kāi)發(fā)、復(fù)用。2.4.2.子系統(tǒng)間關(guān)系{裁剪說(shuō)明：必填}{明確子系統(tǒng)之間的調(diào)用關(guān)系、子系統(tǒng)間的接口〔消息、數(shù)據(jù)結(jié)構(gòu)〕以及相關(guān)子系統(tǒng)之間的協(xié)同工作，可以使用結(jié)構(gòu)圖、〔交互〕事務(wù)圖、消息序列圖、ER圖描述。}模板編號(hào)GENWEB模板版本3?子系統(tǒng)1設(shè)計(jì){裁剪說(shuō)明：必填}{標(biāo)題上加入子系統(tǒng)的編號(hào)及名稱〔標(biāo)識(shí)〕}{“子系統(tǒng) >模塊”劃分。}{目的：1〕設(shè)計(jì)子系統(tǒng)整體框架：子系統(tǒng)的邏輯結(jié)構(gòu)；2〕模塊的劃分與依賴關(guān)系定義、模塊之間的接口定義、模塊功能定義。}3.1.任務(wù)概述目標(biāo){裁剪說(shuō)明：可選}{說(shuō)明設(shè)計(jì)意圖目標(biāo)〔總目標(biāo)、分期目標(biāo)〕、作用范圍等。}3.1.2.需求概述{裁剪說(shuō)明：可選}{解釋軟件產(chǎn)品將完成或不完成的功能〔可以直接描述也可以參考相關(guān)文檔〕}3.2.設(shè)計(jì)概述總體約束開(kāi)發(fā)標(biāo)準(zhǔn){裁剪說(shuō)明：可選。如果已填寫在，此處則略。}〔1〕編碼約定{規(guī)定代碼體系、模塊之間的接口和命名規(guī)則。}模板編號(hào)GENWEB模板版本〔2〕文件約定{規(guī)定子系統(tǒng)的所有配置、日志等文件命名方式與格式。}〔3〕目錄約定{規(guī)定子系統(tǒng)的目錄結(jié)構(gòu)，包括運(yùn)行目錄、源文件目錄、配置目錄、日志目錄、數(shù)據(jù)目錄等。}3212XX約束{裁剪說(shuō)明：可選。如果已填寫在，此處則略。}{列出對(duì)軟件設(shè)計(jì)有重要影響的系統(tǒng)內(nèi)外部約束和限制，可選的約束包括：?用戶環(huán)境?內(nèi)存或其它資源限制?數(shù)據(jù)存儲(chǔ)和分發(fā)需求?安全和可靠性需求?性能需求?測(cè)試和可維護(hù)性需求}3.2.2.子系統(tǒng)外部接口{裁剪說(shuō)明：如果第2章已刪除，這里必填〔如果有〕。}{描述該軟件子系統(tǒng)與外部實(shí)體的接口，包括用戶界面、軟件接口、硬件接口和通信接口。}{軟件子系統(tǒng)的外部實(shí)體，包括：操作系統(tǒng)、驅(qū)動(dòng)程序、硬件、中斷、其它軟件子系統(tǒng)等。}{描述待開(kāi)發(fā)軟件子系統(tǒng)與外部實(shí)體的關(guān)系，可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事務(wù)圖等來(lái)描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系，并標(biāo)示出外部實(shí)體和本系統(tǒng)相互作用的性質(zhì)〔比方：消息、庫(kù)調(diào)用〕和類型〔比方：OS服務(wù)、通信服務(wù)、系統(tǒng)工具等〕。}{詳細(xì)描述子系統(tǒng)外部接口的參數(shù)，如：?接口名稱調(diào)用方式傳輸?shù)臄?shù)據(jù)：-哪些數(shù)據(jù)項(xiàng)?模板編號(hào)GENWEB模板版本-數(shù)據(jù)格式?-長(zhǎng)度？-類型？頻度〔實(shí)時(shí)/批處理〕數(shù)據(jù)同步機(jī)制平臺(tái)無(wú)關(guān)性?遵循的標(biāo)準(zhǔn)?提供的功能?前置條件?后置條件}3.2.3.設(shè)計(jì)方案概述{裁剪說(shuō)明：必填。如果在“”中已描述過(guò)的部分，可略。}{描述內(nèi)容包括：〔1〕整個(gè)設(shè)計(jì)所采用的方法：面向?qū)ο笤O(shè)計(jì)還是結(jié)構(gòu)化設(shè)計(jì)〔2〕采用的系統(tǒng)架構(gòu)：例如MVC架構(gòu)、N層架構(gòu)〔3〕使用的相應(yīng)技術(shù)和工具：例如OMT、Rose、Visio〔4〕采用的框架技術(shù)的形式〔5〕使用的設(shè)計(jì)模式：層模式、微內(nèi)核模式、代理模式等〔6〕描述資源/內(nèi)存分配，F(xiàn)lash資源/文件分配〔7〕描述哪些模塊采用軟件復(fù)用}3.3.子系統(tǒng)架構(gòu)設(shè)計(jì){裁剪說(shuō)明：必填}{定義子系統(tǒng)的總體邏輯結(jié)構(gòu)，定義模塊劃分以及模塊之間的依賴關(guān)系。}{可以采用分層結(jié)構(gòu)描述如何將子系統(tǒng)分解為模塊。}模板編號(hào)GENWEB模板版本{結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖、層次分解圖、數(shù)據(jù)流圖，并用文字說(shuō)明相互間的關(guān)系。}{舉例，繪制結(jié)構(gòu)圖如下：具有繼承等關(guān)系的類圖的可使用UML等工具畫(huà)出關(guān)系圖，如下:LoginActlvityBaseTabActivityeom.tel.e&mmon.eshare,htftpMyHloimieActiMt#WelboCanitentActMtycam.td.commcm.c^hare.dbPastWeiboAetivltyMySpacaActlvityconn.tel.cqmimon?cshare,dmLoginActlvityBaseTabActivityeom.tel.e&mmon.eshare,htftpMyHloimieActiMt#WelboCanitentActMtycam.td.commcm.c^hare.dbPastWeiboAetivltyMySpacaActlvityconn.tel.cqmimon?cshare,dmeem?tel亡cmmamcshaireaexeeptionweiboAandlroid模板編號(hào)GENWEB模板版本EomhEomhtci(eomman.cshare3.4.模塊定義341■模塊列表｛裁剪說(shuō)明：必填｝｛列舉模塊時(shí)，可以采用表格方式〔編號(hào)可以省略〕。｝模塊編號(hào)模塊名稱〔標(biāo)識(shí)〕功能簡(jiǎn)述開(kāi)發(fā)方式模板編號(hào)GENWEB模板版本注：開(kāi)發(fā)方式可選：采購(gòu)、外包/自行開(kāi)發(fā)/復(fù)用3.4.2.模塊間關(guān)系{裁剪說(shuō)明：必填}{明確模塊之間的調(diào)用關(guān)系、模塊間的接口〔消息、數(shù)據(jù)結(jié)構(gòu)〕以及相關(guān)模塊之間的協(xié)同工作如模塊間時(shí)序圖，協(xié)作圖，以及系統(tǒng)之間狀態(tài)切換流程圖。}3.4.3.模塊描述.模塊1{標(biāo)題上加入模塊的編號(hào)及名稱〔標(biāo)識(shí)〕}1〕功能描述{裁剪說(shuō)明：必填}{說(shuō)明該模塊具備什么樣的基本功能，以及每個(gè)功能之間的相互關(guān)系。}2〕性能描述{裁剪說(shuō)明：必填}{說(shuō)明對(duì)模塊的性能要求，包括精度、時(shí)間特性和處理速度。}3〕接口描述{裁剪說(shuō)明：必填}{說(shuō)明與其它模塊的接口，與其它系統(tǒng)或硬件的接口。}{對(duì)于接口函數(shù)，可以采用以下形式描述：接口1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實(shí)現(xiàn)的目的。{需要明確的信息包括：1〕輸入項(xiàng)列出模塊每一個(gè)輸入項(xiàng)的特性，包括名稱、方式、數(shù)量和頻度、輸入介質(zhì)等；可以是邏輯層面的輸入項(xiàng)，如：圖片資源、入項(xiàng)，如變量1、變量2，等等。2〕輸出項(xiàng)列出模塊每一個(gè)輸出項(xiàng)的特性，包括名稱、方式、數(shù)量和頻度、輸出介質(zhì)等。}返回：描述返回什么。描述：總體描述該接口實(shí)現(xiàn)的目的。{需要明確的信息包括：1〕輸入項(xiàng)列出模塊每一個(gè)輸入項(xiàng)的特性，包括名稱、方式、數(shù)量和頻度、輸入介質(zhì)等；可以是邏輯層面的輸入項(xiàng)，如：圖片資源、入項(xiàng)，如變量1、變量2，等等。2〕輸出項(xiàng)列出模塊每一個(gè)輸出項(xiàng)的特性，包括名稱、方式、數(shù)量和頻度、輸出介質(zhì)等。}4〕配置描述{裁剪說(shuō)明：可選}{說(shuō)明該模塊所處的邏輯位置、物理位置，模板編號(hào)GENWEB模板版本標(biāo)識(shí)、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入媒體流、網(wǎng)絡(luò)數(shù)據(jù)等，也可以是具體的物理層面的輸標(biāo)識(shí)、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍、輸出如指明模塊放在哪個(gè)應(yīng)用服務(wù)器或客戶端的哪個(gè)目錄、哪個(gè)文件〔庫(kù)〕，或是在數(shù)據(jù)庫(kù)內(nèi)部建立的對(duì)象。}.模塊2{同。}非功能性需求的實(shí)現(xiàn)方案{裁剪說(shuō)明：整章可選}6.1.性能的考慮{如：為滿足延時(shí)、吞吐量等性能，在既定硬件環(huán)境約束下所采取的設(shè)計(jì)方案。}模板編號(hào)GENWEB模板版本6?