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

軟件概要設(shè)計(jì)說明書范例XX概要設(shè)計(jì)說明書準(zhǔn)某某某文檔修改記錄修改日期修改日期版本/狀態(tài)作者修改章節(jié)修改描述20171017某某某初版發(fā)布填寫說明1.系統(tǒng)結(jié)構(gòu)的定義本體系對整個軟件系統(tǒng)按如下結(jié)構(gòu)方式進(jìn)行劃分：系統(tǒng)子系統(tǒng)模塊子模塊(1)“系統(tǒng)子系統(tǒng)”劃分屬于“系統(tǒng)設(shè)計(jì)”，在系統(tǒng)設(shè)計(jì)說明書中予以描述。(2)“子系統(tǒng)模塊”劃分屬于“概要設(shè)計(jì)”，在本說明書中予以描述。(3)“模塊子模塊”劃分屬于“詳細(xì)設(shè)計(jì)”，在詳細(xì)設(shè)計(jì)說明書中予以描述。如果系統(tǒng)相對簡單，可以省略“子模塊”這一層次。(即第2章)。計(jì)說明書，只須填寫本說明書，直接套用“子系統(tǒng)模塊”劃分(即第3章)進(jìn)行“系統(tǒng)模塊”劃分(把其中“子系統(tǒng)”一詞替換為“系統(tǒng)”)，并刪除本說明書中“系統(tǒng)子系統(tǒng)”劃分的相關(guān)內(nèi)容(第2章)。...............................................................................................錯誤!未定義書簽。.背景和目的........................................................................................................錯誤!未定義書簽。.范圍....................................................................................................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。.........................................................................................................錯誤!未定義書簽。.任務(wù)概述............................................................................................................錯誤!未定義書簽。.設(shè)計(jì)概述............................................................................................................錯誤!未定義書簽。。.子系統(tǒng)定義........................................................................................................錯誤!未定義書簽。義書簽。義書簽。....................................錯誤!未定義書簽。.任務(wù)概述............................................................................................................錯誤!未定義書簽。.設(shè)計(jì)概述............................................................................................................錯誤!未定義書簽。。義書簽。...............................................錯誤!未定義書簽。.模塊定義............................................................................................................錯誤!未定義書簽。未定義書簽。未定義書簽。未定義書簽。4.非功能性需求的實(shí)現(xiàn)方案..............................................................................................錯誤!未定義書簽。.性能的考慮........................................................................................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。.安全的考慮........................................................................................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。...............................................錯誤!未定義書簽。...........................................................................................................錯誤!未定義書簽。..........................................................................................................錯誤!未定義書簽。......................................錯誤!未定義書簽。1.1.背景和目的本文檔編制的目的是說明對軟件系統(tǒng)的設(shè)計(jì)考慮，包括軟件系統(tǒng)的基本處理流程，軟件系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯處理設(shè)計(jì)等，為軟件的詳細(xì)設(shè)計(jì)奠定基礎(chǔ)。1.2.范圍本文檔適用于消息推送項(xiàng)目二期產(chǎn)品的服務(wù)端。1.3.術(shù)語和縮略語英英文全名TheExtensibleMessagingandPresenceProtocol可擴(kuò)展通訊和表示協(xié)議縮略語XMPP2.系統(tǒng)總體設(shè)計(jì)章省義。}2.1.任務(wù)概述2.2.設(shè)計(jì)概述用spring+mina+jgroups建立一個分布式的服務(wù)端系統(tǒng)，以XMPP協(xié)議提供2.3.系統(tǒng)架構(gòu)設(shè)計(jì)架構(gòu)設(shè)計(jì)3)邏輯處理層：終端協(xié)議服務(wù)器、推送服務(wù)器(RS)、統(tǒng)計(jì)服務(wù)器。a終端協(xié)議服務(wù)器：終端往接入服務(wù)器發(fā)送協(xié)議包，接入服務(wù)器轉(zhuǎn)發(fā)給終端協(xié)b)推送服務(wù)器：負(fù)責(zé)從MQ取出消息、解析消息(條件體和消息體)、終端在線和離線查詢、按各接入服務(wù)器有哪些終端登錄把消息包分發(fā)給接入服務(wù)artz三方推送接口，供第三方云端調(diào)用的API，提供單點(diǎn)推送(明消息/暗消息)、條件(區(qū)域+機(jī)型)推送、regid推送。6)WEB層：運(yùn)營平臺、第三方推送平臺。2.3.1.2.架構(gòu)設(shè)計(jì)2.4.子系統(tǒng)定義子子系統(tǒng)名稱(標(biāo)1234567統(tǒng)等送(明消息/暗消息)、條件(區(qū)域+取出消息、解析消息(條件體和消息體)、終端在線和離線查詢、按各接入服務(wù)器有哪些終端登錄把消息包分激活結(jié)果等XMPP協(xié)議。提供獲取接入服務(wù)器列{明確子系統(tǒng)之間的調(diào)用關(guān)系、子系統(tǒng)間的接口(消息、數(shù)據(jù)結(jié)構(gòu))以及相關(guān)子系統(tǒng)之間的協(xié)同工作，可以使用結(jié)構(gòu)圖、(交互)事務(wù)圖、消息序列圖、ER圖描述。}{標(biāo)題上加入子系統(tǒng)的編號及名稱(標(biāo)識)}之間的接口定義、模塊功能定義。}3.1.任務(wù)概述3.1.1.目標(biāo){說明設(shè)計(jì)意圖目標(biāo)(總目標(biāo)、分期目標(biāo))、作用范圍等。}{解釋軟件產(chǎn)品將完成或不完成的功能(可以直接描述也可以參考相關(guān)文檔)}3.2.設(shè)計(jì)概述3.2.1.1.開發(fā)規(guī)范(1)編碼約定}(2)文件約定式與格式。}(3)目錄約定{規(guī)定子系統(tǒng)的目錄結(jié)構(gòu)，包括運(yùn)行目錄、源文件目錄、配置目錄、日志目錄、數(shù)據(jù)目錄等。}3.2.1.2.XX約束{列出對軟件設(shè)計(jì)有重要影響的系統(tǒng)內(nèi)外部約束和限制，可選的約束包括：用戶環(huán)境?內(nèi)存或其它資源限制?數(shù)據(jù)存儲和分發(fā)需求?安全和可靠性需求性能需求{裁剪說明：如果第2章已刪除，這里必填(如果有)。}{描述該軟件子系統(tǒng)與外部實(shí)體的接口，包括用戶界面、軟件接口、硬件接口和通信接口。}{軟件子系統(tǒng)的外部實(shí)體，包括：操作系統(tǒng)、驅(qū)動程序、硬件、中斷、其它軟件子系統(tǒng)等。}{描述待開發(fā)軟件子系統(tǒng)與外部實(shí)體的關(guān)系，可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事務(wù)圖等來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系，并標(biāo)示出外部實(shí)體和本系統(tǒng)相互作用的性質(zhì)(比如：消息、庫調(diào)用)和類型 {詳細(xì)描述子系統(tǒng)外部接口的參數(shù)，如：據(jù)格式–長度–類型設(shè)計(jì)概述”中已描述過的部分，可略。}(1)整個設(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ì){定義子系統(tǒng)的總體邏輯結(jié)構(gòu)，定義模塊劃分以及模塊之間的依賴關(guān)系。}{結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖、層次分解圖、數(shù)據(jù)流圖，并用文字說明相互間的關(guān)系。}可使用UML等工具畫出關(guān)系圖，如下：}3.4.模塊定義{列舉模塊時，可以采用表格方式(編號可以省略)。}模模塊名稱(標(biāo)識)模塊編號開發(fā)方式功能簡述/自行開發(fā)/復(fù)用{明確模塊之間的調(diào)用關(guān)系、模塊間的接口(消息、數(shù)據(jù)結(jié)構(gòu))以及相關(guān)模塊之間{標(biāo)題上加入模塊的編號及名稱(標(biāo)識)}1)功能描述{說明該模塊具備什么樣的基本功能，以及每個功能之間的相互關(guān)系。}2)性能描述求，包括精度、時間特性和處理速度。}3)接口描述{對于接口函數(shù)，可以采用以下形式描述：什么。(1)輸入項(xiàng)列出模塊每一個輸入項(xiàng)的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入方式、數(shù)量和頻度、輸入介質(zhì)等；可以是邏輯層面的輸入項(xiàng)，如：圖片資源、媒體流、網(wǎng)絡(luò)數(shù)據(jù)等，也可以是具體的物理層面的(2)輸出項(xiàng)列出模塊每一個輸出項(xiàng)的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍、輸4)配置描述{說明該模塊所處的邏輯位置、物理位置，如指明模塊放在哪個應(yīng)用服務(wù)器或客戶端的哪個目錄、哪個文件(庫)，或是在數(shù)據(jù)庫內(nèi)部建立的對象。}4.非功能性需求的實(shí)現(xiàn)方案6.1.性能的考慮6.2.兼容性的考慮6.3.安全的考慮6.4.可移植性的考慮}6.5.集成與測試的考慮{各個子系統(tǒng)以及模塊以什么先后次序進(jìn)行開發(fā)、集成(組裝)和測試，即