軟件概要設計模板

｛子系統(tǒng)名稱｝XX軟件概要設計說明擬制： 審核： 會簽： 質(zhì)量保證：批準：

文檔修改記錄版本號修改內(nèi)容描述修改人日期備注1范圍錯誤!未定義書簽。標識 錯誤!未定義書簽。術語及縮略語錯誤!未定義書簽。文檔概述2引用文檔錯誤!未定義書簽。錯誤!未定義書簽。3軟件設計約束錯誤!未定義書簽。應遵循的標準或標準錯誤!未定義書簽。接口/協(xié)議的約束質(zhì)量約束錯誤!未定義書簽。錯誤!未定義書簽。隱含約束錯誤!未定義書簽。4軟件的設計謀略錯誤!未定義書簽。5邏輯包的劃分及設計邏輯包的劃分錯誤!未定義書簽。錯誤!未定義書簽。XX邏輯包設計錯誤!未定義書簽。YY邏輯包設計6執(zhí)行概念包級執(zhí)行設計錯誤!未定義書簽。錯誤!未定義書簽。錯誤!未定義書簽。XXXX包執(zhí)行設計錯誤!未定義書簽。7外部接口設計外部接口示意及標識外部接口描述錯誤!未定義書簽。錯誤!未定義書簽。錯誤!未定義書簽。8內(nèi)部接口設計9與上級文檔的追溯關系正向追溯錯誤!未定義書簽。錯誤!未定義書簽。錯誤!未定義書簽。逆向追溯錯誤!未定義書簽。逆向追溯1范圍1.1標識本文檔的題目：本文檔的標識：本文檔的版本號：1.2術語及縮略語本文檔中利用的術語及縮略語詳見下表:本文檔各章節(jié)內(nèi)容說明如下表:表3引用文檔一覽表序號文檔標識文檔名稱版本號備注1.《XX軟件系統(tǒng)概述》2.3.4.5.3軟件設計約束注1： 本節(jié)描述在概要設計時期制定的設計約束，對“軟件需求規(guī)格說明”中概念的設計約束可直接引用沒必要詳細描述。3.1應遵循的標準或標準注1：本節(jié)描述需求中規(guī)定的或項目組內(nèi)部制定的設計應遵循的標準、標準。如有必要可作為本文檔的周圍單獨列出。3.2接口/協(xié)議的約束注1：本節(jié)描述需求中概念的軟件對外的接口和必需遵循的協(xié)議。3.3質(zhì)量約束注1：描述需求規(guī)定的或組織規(guī)定的軟件質(zhì)量約束，如正確性、健壯性、靠得住性、性能、易用性、清楚性、平安性、可擴展性、兼容性或可移植性。3.4隱含約束注1：描述需求中未明確指出的假設或依托，這些假設或依托對軟件的設計將會產(chǎn)生必然的阻礙。4軟件的設計謀略注1：本節(jié)描述軟件的設計謀略，要緊包括：注2： 設計模式：描述C/S結構、B/S結構、消息驅(qū)動、界面模式注3： 其它模式：擴展策略、復用策略、折衷策略。5邏輯包的劃分及設計注1：在本節(jié)劃分邏輯包，并分章節(jié)對各邏輯包進行概念。5.1邏輯包的劃分注1：畫出整個軟件的邏輯包視圖的組成，要求畫到類包（該包全數(shù)由類組成，不能再劃分為子包）一級。同時對包的組織作簡要介紹。表4 “包”一覽表序號包的名稱包的標識層級編號包的簡要描述表5“類”的一覽表序號類名類標識歸屬包的標識父類層級編號5.2XX邏輯包設計注1：從本節(jié)開始，對每一個類包的類圖進行說明。5.2.1包的類圖注1：畫出包的靜態(tài)類圖，簡要介紹包中類的組成。5.2.2類的說明注1：本節(jié)描述邏輯包中類與UseCase功能/輔助功能的映射關系及類的物理位置。XX包中類的物理位置5.3.1包的類圖5.3.2類的說明6執(zhí)行概念注1： 本節(jié)描述各包中類的執(zhí)行概念。應包括表示各包中類之間動態(tài)關系的圖示和說明。6.1包級執(zhí)行設計6.1.1包間的進程圖注1： 畫出類包一級的進程圖。依照需要可配以文字說明。6.1.2包間的序列圖注1： 畫出類包間執(zhí)行序列圖，來描述類包間的執(zhí)行時序和消息等其它關系。對每一各序列圖引用主事件流(MainFlow)和子事件流(Subflow)來講明正常的執(zhí)行操縱進程，執(zhí)行時的中斷處置或異樣處置可通過備選事件流(AlternativeFlow)來講明。6.2XX包執(zhí)行設計注1： 以下各末節(jié)可依照具體需要進行裁剪，各末節(jié)順序可調(diào)整。6.2.1包內(nèi)的序列圖注1： 分末節(jié)對各個執(zhí)行重要功能的類包畫出它們內(nèi)部各類或?qū)ο笾g的序列圖。同時配以適當?shù)奈淖终f明。6.2.2狀態(tài)圖注1： 分末節(jié)畫出其狀態(tài)對其操縱功能有重要阻礙的類的狀態(tài)圖，同時可描述出該類對象的生命周期。6.2.3進程轉(zhuǎn)換狀態(tài)圖注1： 分末節(jié)畫出執(zhí)行時進程的動態(tài)創(chuàng)建與刪除圖示。6.2.4并發(fā)處置注1：用文字、表格或適合的工具說明并發(fā)執(zhí)行的激活點等動態(tài)行為。7外部接口設計注1： 本節(jié)描述軟件的外部接口特性注2： 只描述對軟件需求規(guī)格說明(SRS)中的接口需求部份做出修改或增加的接口，其余相同的部份可在此引用；注3： 若是本節(jié)部份內(nèi)容已在接口設計說明(IDD)中給出，那么在此引用沒必要具體描述。如接口設計說明中沒有提供，那么必然要在此處給出。7.1外部接口示意及標識注1： 畫出接口示用意，為清楚表達出外部實體與軟件內(nèi)部模塊的關系，要求畫外部接口時直接與模塊關聯(lián)。表7 外部接口一覽表序號接口名稱接口標識功能描述接口類型優(yōu)先級別發(fā)達方注2：接口類型，如：實時數(shù)據(jù)傳送、數(shù)據(jù)的存儲和檢索等；注3： 當接口有優(yōu)先級要求時（猶如一個接口有多個接收方），可指出它們之間的優(yōu)先級別；注4： 說明作為發(fā)送方/接收方的模塊時，填寫模塊名稱，以明確表達接話柄體關系。外部實體可用名字、鄉(xiāng)有外部接口表格中的發(fā)送方/接收方均按此方式標識；注5： 假設該軟件在《系統(tǒng)/子系統(tǒng)需求規(guī)格說明》中被指明處于多個運行狀態(tài)和方式，那么應在此給出該手7.2外部接口描述注1：若是所有外部接口的通信方式特性和協(xié)議特性相同，可放在前面一路說明；個別外部接口這兩方面假設有不同，應在它的特性說明部份另外給出。此處提供的外部接口各個特性的列表只抽取了該特性的部份重要因素。編寫文檔時可參考《系統(tǒng)/子系統(tǒng)需求規(guī)格說明》相應部份的詳細列表，結合具體情形對它們進行裁剪。7.2.1通信方式特性表8 外部接口的通信方式特性通信方法名稱通信方法標識通信鏈路/帶寬/頻率特性數(shù)據(jù)傳送特性傳輸服務其它特性適用的接口名稱/標識注1：數(shù)據(jù)傳送特性，包括傳送速度、周期或非周期和傳送距離；注2： 傳輸效勞，包括：優(yōu)先級別和品級；注3： 其它特性，可包括：平安性/保密性/私密性方面的考慮，如：加密、用戶辨別、隔離、審計等；流操縱（如：序列編號緩和沖區(qū)分派）；消息格式化；路由、尋址、命名約定等內(nèi)容。7.2.2協(xié)議方式特性表9 外部接口的協(xié)議方式特性協(xié)議方法名稱協(xié)議方法識符優(yōu)先級/層分組同步其它特性適用的接口名稱/標識注1：分組，包括：分段和重組、路由、尋址；注2： 同步，包括：連接的成立、保護、終止；注3： 其它特性，可包括：合法性檢查、錯誤操縱和恢復進程；狀態(tài)、標識、任何其它的報告特點等內(nèi)容。7.2.3（外部接口的名稱和項目唯一標識符）注1：從開始編號；

注2： 本節(jié)所屬的各末節(jié)只針對一個外部接口的設計進行詳細說明。7.2.3.1數(shù)據(jù)元素特性注1： 說明接話柄體必需提供、存儲、發(fā)送、訪問、接收的單個數(shù)據(jù)元素的特性。表10 （接口名稱）的數(shù)據(jù)元素特性數(shù)據(jù)元素名稱數(shù)據(jù)元素標識用途數(shù)據(jù)類型數(shù)據(jù)長度范圍或精度發(fā)送方接收方其它特性注1：名稱，可包括：非技術（自然語言）名稱；軍用標準數(shù)據(jù)元素名稱；技術名稱（如代碼或數(shù)據(jù)庫中的變量或字段名）；縮寫名或同義名；注2： 數(shù)據(jù)類型，如字母數(shù)字、整數(shù)等；注3： 數(shù)據(jù)長度，包括數(shù)據(jù)大小和氣宇單位；注4： 其它特性，包括優(yōu)先級別、時序、頻率、容量、序列、其它的約束條件，如：數(shù)據(jù)元素是不是可被更新、業(yè)務規(guī)那么是不是適用；保密性和私密性的約束等。7.2.3.2數(shù)據(jù)元素集合體特性注1： 說明接話柄體必需提供、存儲、發(fā)送、訪問、接收的數(shù)據(jù)元素集合體的特性。表11（接口名稱）的數(shù)據(jù)元素集合體特性數(shù)據(jù)兀素集合體名稱項目唯一標識符用途集合體類型包含的數(shù)據(jù)元素名稱數(shù)據(jù)元素序號發(fā)送方接收方其它特性注2： 集合體類型，如記錄、消息、文件、數(shù)組、顯示、報表等。注3： 數(shù)據(jù)元素序號，指該數(shù)據(jù)元素在集合體中的順序；注4： 其它特性，包括集合體間的關系，如排序/訪問特性；顯示和其它輸出的視聽特性;優(yōu)先級別、時序、頻率、容量、序列、其它的約束條件，如：數(shù)據(jù)元素是不是可被更新、業(yè)務規(guī)那么是不是適用；保密性和私密性的約束等。7.2.3.3通信方式特性注1：假設本接口的通信方式與其它外部接口不同，那么按節(jié)的形式在此給出。不然，本末節(jié)應省略。7.2.3.4協(xié)議方式特性注1：假設本接口的協(xié)議方式與其它外部接口不同，那么按節(jié)的形式在此給出。不然，本末節(jié)應省略。7.2.3.5其它接口特性注1：描述接口其它所需的特性，如：接話柄體的物理兼容性(尺寸、容限、負荷、電壓和接插件兼容性等)。注2： 假設說明某個接口特性時，省略了和節(jié)的內(nèi)容，本末節(jié)的編號應為。8內(nèi)部接口設計注1：參考軟件需求規(guī)格說明(SRS)中的UseCase結構圖，畫出接口示用意。為幸免重復或混亂，本節(jié)只要求畫出最底一層軟件模塊之間的接口關系?？墒菫榱吮磉_出上級的軟件模塊的接口關系，在描述最底一層軟件模塊之間接口的發(fā)送方和接收方時，須按“較高一級的軟件模塊名稱：下一級的軟件模塊名稱：...：最底層的軟件模塊名稱”的形式來描述，其中“較高一級的軟件模塊”可上溯到發(fā)送方和接收方的上級是同一個軟件模塊時為止；其它約定合格式參見外部接口部份。9與上級文檔的追溯關系9.1正向追溯表12正向追溯表序號上級文檔被追蹤內(nèi)容的名稱/標識本文檔中被追蹤內(nèi)容的名稱/標識備注注1： 追溯粒度大小應合理注2： “上級文檔被追蹤內(nèi)容的名稱/標識”一欄中可依照項目具體情形填寫，如“軟件需求的名稱/標識”或“界面需求名稱/標識”等等。注3： “本文檔中被追蹤內(nèi)容的名稱/標識”一欄中可依照項目具體情形填寫，如“包的名稱/標識”或“類的標識”等等。注4： 若是上一級文檔由多份文檔組成，應標明上一級文檔的名稱/標識

9.2逆向追溯