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

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

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

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

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