軟件總體設(shè)計(jì)說明書

1、文檔編號(hào)廣品版本密級(jí)產(chǎn)品名稱：共頁系統(tǒng)或模塊名稱軟件總體設(shè)計(jì)說明書（僅供內(nèi)部使用）擬制：日期：yyyy-mm-dd審核：日期：yyyy-mm-dd核準(zhǔn)：日期：yyyy-mm-dd日期：yyyy-mm-dd文檔版本:版權(quán)所有侵權(quán)必究文件修改記錄修改日期版本修改頁他、章節(jié)、條款修改描述作者yyyy-mm-dd1引言51.1 目的51.2 范圍52總體概述51 指標(biāo)描述51 本系統(tǒng)上下文說明51.6 軟件結(jié)構(gòu)51.6 硬件結(jié)構(gòu)（可選）51 設(shè)計(jì)約束51.7 遵循標(biāo)準(zhǔn)（可選）51.7 硬件約束（可選）61.7 其他約束（可選）61 其他（可選）63軟件總體結(jié)構(gòu)61.1.2 分解視圖61 分解說明61

2、各實(shí)體說明61 初始化/配置說明61.2.2 運(yùn)行視圖61.3.2 開發(fā)視圖74接口說明71.1.5 用戶接口71.2.5 外部接口75各功能實(shí)體與處理流程說明7全局?jǐn)?shù)據(jù)結(jié)構(gòu)定義與說明8主要數(shù)據(jù)結(jié)構(gòu)之間的關(guān)系8各功能實(shí)體以及處理流程說明8功能實(shí)體18功能實(shí)體286出錯(cuò)處理設(shè)計(jì)8出錯(cuò)信息8出錯(cuò)處理設(shè)計(jì)8系統(tǒng)維護(hù)設(shè)計(jì)97開發(fā)環(huán)境說明98其他9軟件總體設(shè)計(jì)說明書關(guān)鍵詞：摘要：縮略語說明:縮略語英文全名中文解釋參考資料：列出本文檔的所有參考文獻(xiàn)（包括：正式/非正式出版物、公司/部門文檔等），格式如下:作者+書名（或雜志、文獻(xiàn)、文檔）+出版社（或期號(hào)、卷號(hào)、公司文檔編號(hào)）+出版日期模板使用說明：1注明可

3、選的部分，可以根據(jù)實(shí)際情況選擇是否填寫；如果不必說明，請(qǐng)務(wù)必保留相關(guān)的章節(jié)標(biāo)題，同時(shí)在該可選章節(jié)的內(nèi)容中填入“無”；未注名可選的，則必須描述；如果有些設(shè)計(jì)此模版中沒有合適的地方填寫，則補(bǔ)充在最后的其他欄目中2模版中斜體字相當(dāng)于撰寫指南，最后文稿請(qǐng)將本模板中所有的斜體字部分全部刪除。3模板里并不說明設(shè)計(jì)技術(shù)和方法，而只是說明應(yīng)包含哪些內(nèi)容，以及如何描述、組織這些內(nèi)容。4對(duì)于移植的代碼，描述可以相對(duì)簡(jiǎn)單一些，但以下這些章節(jié)不能省略：指標(biāo)描述、本系統(tǒng)上下文說明、初始化/配置說明、開發(fā)視圖、接口說明、移植一些說明和考慮可以放在其它一節(jié)中1引言目的說明本設(shè)計(jì)是為了滿足軟件需求規(guī)格說明書中的哪些需求而做的

4、，指明讀者對(duì)象范圍說明文檔所包括的內(nèi)容2總體概述指標(biāo)描述說明本系統(tǒng)或模塊所實(shí)現(xiàn)的詳細(xì)指標(biāo)本系統(tǒng)上下文說明軟件結(jié)構(gòu)簡(jiǎn)要說明本系統(tǒng)與外部軟件系統(tǒng)的上下文關(guān)系，表示方法可以采用結(jié)構(gòu)圖、數(shù)據(jù)流圖、UM博。目的是為了描述本系統(tǒng)與外部系統(tǒng)的交互關(guān)系。比如，PP暇塊的總體設(shè)計(jì)，這里就需要說明PP叫鏈路層框架的關(guān)系，PPP與網(wǎng)絡(luò)層的關(guān)系，PP叫AAA的關(guān)系等，當(dāng)然，如果對(duì)OSW特別需求的話，在這里也可以進(jìn)行描述。這里的描述不是說寫出一個(gè)函數(shù)接口的說明，而是對(duì)相互關(guān)聯(lián)關(guān)系的說明，一般包括數(shù)據(jù)的流向路徑，管理路徑等。如果用圖不能描述清楚，則請(qǐng)用自然語言補(bǔ)充說明，這里要求考慮到每個(gè)路徑。硬件結(jié)構(gòu)（可選）此處著重說明

5、本系統(tǒng)依附的硬件架構(gòu)，對(duì)于非驅(qū)動(dòng)類軟件模塊，本節(jié)可以省略。這里的描述格式不做更細(xì)的約定，由設(shè)計(jì)人員自行把握。設(shè)計(jì)約束遵循標(biāo)準(zhǔn)（可選）描述本系統(tǒng)所遵循的標(biāo)準(zhǔn)、規(guī)范。硬件約束（可選）描述本軟件系統(tǒng)實(shí)現(xiàn)的硬件約束，比如，對(duì)內(nèi)存的限制等。這是對(duì)硬件結(jié)構(gòu)的補(bǔ)充，前面可以說明硬件的總體框架，功能框圖。這兒著重講解硬件對(duì)軟件的限制，比如不提供某種信號(hào)導(dǎo)致軟件設(shè)計(jì)中需要注意的地方或者說限制。其他約束（可選）描述本軟件系統(tǒng)設(shè)計(jì)時(shí)需要遵循的其它約束。其他（可選）描述其他有關(guān)的設(shè)計(jì)考慮。3軟件總體結(jié)構(gòu)分解視圖分解說明提供本系統(tǒng)（模塊）的內(nèi)部結(jié)構(gòu)圖并加以描述。這里其實(shí)是提供了本系統(tǒng)的一個(gè)分解視圖，一個(gè)系統(tǒng)一般就是由一

6、個(gè)個(gè)實(shí)體（可以是子模塊、數(shù)據(jù)等）構(gòu)成。這里，就是請(qǐng)大家將這個(gè)分解視圖描述清楚，可以使用層次分解圖加自然語言的形式加以描述（但不限于此描述方法）。分解的結(jié)果就是能夠清晰地看出本系統(tǒng)由哪些實(shí)體組成，以及這些實(shí)體間的關(guān)聯(lián)關(guān)系。各實(shí)體說明簡(jiǎn)要說明上述分解視圖中各個(gè)實(shí)體的功能初始化/配置說明說明本系統(tǒng)的初始化依賴關(guān)系，也就是說，本系統(tǒng)需要在哪些系統(tǒng)的初始化之后，才能進(jìn)行初始化。簡(jiǎn)要說明本系統(tǒng)提供了哪些配置項(xiàng)，可以對(duì)系統(tǒng)進(jìn)行相應(yīng)的配置，以滿足不同的產(chǎn)品需求。運(yùn)行視圖運(yùn)行說明描述了實(shí)體間的關(guān)系。運(yùn)行視圖定義本系統(tǒng)各個(gè)實(shí)體間交互的關(guān)系，并且為理解系統(tǒng)動(dòng)作是如何運(yùn)行、以及在哪里運(yùn)行，提供了必要的信息。它也說明了

7、實(shí)體間關(guān)系的類型，如共享信息、預(yù)定的執(zhí)行次序、或者是已定義的參數(shù)接口。要描述本系統(tǒng)由哪些線程組成(繪圖)，線程之間的關(guān)系如何，線程分別運(yùn)行在哪個(gè)態(tài)：核心、應(yīng)用或中斷態(tài)。軟件工程學(xué)中定義的一些表示方法，如數(shù)據(jù)流圖、UML流程圖等，都可以用來描述運(yùn)行視圖。開發(fā)視圖描述代碼的組織方式。這里只需要說明本系統(tǒng)的目錄結(jié)構(gòu)，以及代碼的目錄(包括公共目錄，頭文件目錄等)分布。這里不需要寫出代碼具體有多少文件，以及文件名稱等,只要?dú)w類就可以了。4接口說明用戶接口說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及響應(yīng)信息。外部接口【1】描述本模塊對(duì)外提供可以使用的接口說明。接口類型不一定就是函數(shù)，可以是API,回調(diào)，函

8、數(shù)指針，也可以是事件、消息、報(bào)文數(shù)據(jù)、共享內(nèi)存等。描述形式如：(1)接口1:某個(gè)API必須說明以下內(nèi)容：聲明：輸入?yún)?shù)描述：返回值描述：主要功能描述：描述提供該接口實(shí)現(xiàn)的目的；函數(shù)的運(yùn)行要求：允許在哪個(gè)態(tài)運(yùn)行，是否可以重入，以及其他運(yùn)行要注意的條件。(2)接口2:某個(gè)消息消息類型：消息參數(shù)：消息目的：描述該消息的含義和作用實(shí)現(xiàn)方法：描述該消息如何提供，或者說外部如何得到該消息。說明：對(duì)于一些涉及到臨界區(qū)操作白接口，一定要注意加以說明。【2】需要外部提供的接口描述5各功能實(shí)體與處理流程說明如果本設(shè)計(jì)文檔包括好幾個(gè)相對(duì)大的功能模塊，則本章可以細(xì)分為幾章進(jìn)行描述，這個(gè)時(shí)候本章的標(biāo)題可以是“模塊1各功

9、能實(shí)體與處理流程說明”，下一章的標(biāo)題依此類推。全局?jǐn)?shù)據(jù)結(jié)構(gòu)定義與說明描述本系統(tǒng)定義的全局的以及主要的數(shù)據(jù)結(jié)構(gòu)。主要數(shù)據(jù)結(jié)構(gòu)之間的關(guān)系如果有多個(gè)數(shù)據(jù)結(jié)構(gòu)，請(qǐng)說明它們之間的組織關(guān)系。建議使用圖表的形式說明。如果結(jié)構(gòu)比較簡(jiǎn)單，那么文字說明要簡(jiǎn)潔易懂。各功能實(shí)體以及處理流程說明功能實(shí)體1功能1的處理流程說明，可以使用流程圖、UM牌方法進(jìn)行描述。說明如何實(shí)現(xiàn)這些功能，每個(gè)步驟是怎樣實(shí)現(xiàn)的。可根據(jù)功能再進(jìn)行細(xì)分子實(shí)體進(jìn)行描述。這里有一點(diǎn)需要說明的是：如果本功能實(shí)體不再進(jìn)行進(jìn)一步分解的總體設(shè)計(jì)，那么這里必須描述本功能實(shí)體對(duì)外提供的接口，格式同4.2節(jié)功能實(shí)體26出錯(cuò)處理設(shè)計(jì)出錯(cuò)信息用一覽表的方式說朗每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息的形式、含意及處理方法。出錯(cuò)處理設(shè)計(jì)說明系統(tǒng)