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

1、軟件總體設(shè)計說明書文檔編號廣品版本密級產(chǎn)品名稱：共 頁系統(tǒng)或模塊名稱軟件總體設(shè)計說明書（僅供內(nèi)部使用）擬制：日期：yyyy-mm-dd審核：日期：yyyy-mm-dd核準：日期：yyyy-mm-dd日期：yyyy-mm-dd文檔版本:版權(quán)所有 侵權(quán)必究文件修改記錄修改日期版本修改頁他、章節(jié)、條 款修改描述作者yyyy-mm-dd版權(quán)所有侵權(quán)必究81引言51.1 目的51.2 范圍52總體概述 52.1 指標描述52.2 本系統(tǒng)上下文說明 52.2.1 軟件結(jié)構(gòu)52.2.2 硬件結(jié)構(gòu)（可選） 52.3 設(shè)計約束52.3.1 遵循標準（可選） 52.3.2 硬件約束（可選） 62.3.3 其他約束

2、（可選） 62.4 其他（可選）63軟件總體結(jié)構(gòu) 63.1 分解視圖 63.1.1 分解說明 63.1.2 各實體說明 63.1.3 初始化/配置說明 63.2 運行視圖63.3 開發(fā)視圖74接口說明 74.1 用戶接口 74.2 外部接口 75各功能實體與處理流程說明 75.1 全局數(shù)據(jù)結(jié)構(gòu)定義與說明 85.2 主要數(shù)據(jù)結(jié)構(gòu)之間的關(guān)系 85.3 各功能實體以及處理流程說明 85.3.1 功能實體1 85.3.2 功能實體2 86出錯處理設(shè)計 86.1 出錯信息86.2 出錯處理設(shè)計 86.3 系統(tǒng)維護設(shè)計 97開發(fā)環(huán)境說明 98其他 9軟件總體設(shè)計說明書關(guān)鍵詞：摘要：縮略語說明:縮略語英文全

3、名中文解釋參考資料：列出本文檔的所有參考文獻（包括：正式/非正式出版物、公司/部門文檔等），格式如下: 作者+書名（或雜志、文獻、文檔）+出版社（或期號、卷號、公司文檔編號）+出版日期模板使用說明：1注明可選的部分，可以根據(jù)實際情況選擇是否填寫；如果不必說明，請務(wù)必保留相 關(guān)的章節(jié)標題，同時在該可選章節(jié)的內(nèi)容中填入“無”；未注名可選的，則必須描述；如果 有些設(shè)計此模版中沒有合適的地方填寫，則補充在最后的其他欄目中2模版中斜體字相當于撰寫指南，最后文稿請將本模板中所有的斜體字部分全部刪除。3模板里并不說明設(shè)計技術(shù)和方法，而只是說明應(yīng)包含哪些內(nèi)容，以及如何描述、組 織這些內(nèi)容。4對于移植的代碼，描

4、述可以相對簡單一些，但以下這些章節(jié)不能省略：指標描述、 本系統(tǒng)上下文說明、初始化/配置說明、開發(fā)視圖、接口說明、移植一些說明和考慮可以放 在其它一節(jié)中1引言1.1 目的說明本設(shè)計是為了滿足軟件需求規(guī)格說明書中的哪些需求而做的，指明讀者對象1.2 范圍說明文檔所包括的內(nèi)容2總體概述2.1 指標描述說明本系統(tǒng)或模塊所實現(xiàn)的詳細指標2.2 本系統(tǒng)上下文說明2.2.1 軟件結(jié)構(gòu)簡要說明本系統(tǒng)與外部軟件系統(tǒng)的上下文關(guān)系，表示方法可以采用結(jié)構(gòu)圖、數(shù)據(jù)流圖、 UM博。目的是為了描述本系統(tǒng)與外部系統(tǒng)的交互關(guān)系。比如，PP暇塊的總體設(shè)計，這里就需要說明 PP叫鏈路層框架的關(guān)系，PPP與網(wǎng)絡(luò)層 的關(guān)系，PP叫AA

5、A的關(guān)系等，當然，如果對OSW特別需求的話，在這里也可以進行描述。 這里的描述不是說寫出一個函數(shù)接口的說明， 而是對相互關(guān)聯(lián)關(guān)系的說明，一般包括數(shù)據(jù)的 流向路徑，管理路徑等。如果用圖不能描述清楚，則請用自然語言補充說明，這里要求考慮到每個路徑。2.2.2 硬件結(jié)構(gòu)（可選）此處著重說明本系統(tǒng)依附的硬件架構(gòu)，對于非驅(qū)動類軟件模塊，本節(jié)可以省略。 這里的描述格式不做更細的約定，由設(shè)計人員自行把握。2.3 設(shè)計約束2.3.1 遵循標準（可選）描述本系統(tǒng)所遵循的標準、規(guī)范。2.3.2 硬件約束（可選）描述本軟件系統(tǒng)實現(xiàn)的硬件約束，比如，對內(nèi)存的限制等。這是對硬件結(jié)構(gòu)的補充，前 面可以說明硬件的總體框架，

6、功能框圖。這兒著重講解硬件對軟件的限制，比如不提供某種 信號導(dǎo)致軟件設(shè)計中需要注意的地方或者說限制。2.3.3 其他約束（可選）描述本軟件系統(tǒng)設(shè)計時需要遵循的其它約束。2.4 其他（可選）描述其他有關(guān)的設(shè)計考慮。3軟件總體結(jié)構(gòu)3.1 分解視圖3.1.1 分解說明提供本系統(tǒng)（模塊）的內(nèi)部結(jié)構(gòu)圖并加以描述。這里其實是提供了本系統(tǒng)的一個分 解視圖，一個系統(tǒng)一般就是由一個個實體（可以是子模塊、數(shù)據(jù)等）構(gòu)成。這里，就是請大 家將這個分解視圖描述清楚，可以使用層次分解圖加自然語言的形式加以描述 （但不限于此 描述方法）。分解的結(jié)果就是能夠清晰地看出本系統(tǒng)由哪些實體組成，以及這些實體間的關(guān) 聯(lián)關(guān)系。3.1.

7、2 各實體說明簡要說明上述分解視圖中各個實體的功能3.1.3 初始化/配置說明說明本系統(tǒng)的初始化依賴關(guān)系，也就是說，本系統(tǒng)需要在哪些系統(tǒng)的初始化之后，才能進行初始化。簡要說明本系統(tǒng)提供了哪些配置項，可以對系統(tǒng)進行相應(yīng)的配置，以滿足不同的產(chǎn)品需求。3.2 運行視圖運行說明描述了實體間的關(guān)系。運行視圖定義本系統(tǒng)各個實體間交互的關(guān)系，并且 為理解系統(tǒng)動作是如何運行、以及在哪里運行，提供了必要的信息。它也說明了實體間關(guān) 系的類型，如共享信息、預(yù)定的執(zhí)行次序、或者是已定義的參數(shù)接口。要描述本系統(tǒng)由哪些線程組成(繪圖)，線程之間的關(guān)系如何，線程分別運行在哪個 態(tài)：核心、應(yīng)用或中斷態(tài)。軟件工程學(xué)中定義的一些

8、表示方法，如數(shù)據(jù)流圖、UML流程圖等，都可以用來描述運行視圖。3.3 開發(fā)視圖描述代碼的組織方式。這里只需要說明本系統(tǒng)的目錄結(jié)構(gòu)，以及代碼的目錄(包括 公共目錄，頭文件目錄等)分布。這里不需要寫出代碼具體有多少文件，以及文件名稱等, 只要歸類就可以了。4接口說明4.1 用戶接口說明將向用戶提供的命令和它們的語法結(jié)構(gòu)，以及響應(yīng)信息。4.2 外部接口【1】描述本模塊對外提供可以使用的接口說明。接口類型不一定就是函數(shù)，可以是API, 回調(diào)，函數(shù)指針，也可以是事件、消息、報文數(shù)據(jù)、共享內(nèi)存等。描述形式如：(1)接口 1:某個API必須說明以下內(nèi)容：聲明：輸入?yún)?shù)描述：返回值描述：主要功能描述：描述提供

9、該接口實現(xiàn)的目的；函數(shù)的運行要求：允許在哪個態(tài)運行，是否可以重入，以及其他運行要注意的條件。(2)接口 2:某個消息消息類型：消息參數(shù)：消息目的：描述該消息的含義和作用實現(xiàn)方法：描述該消息如何提供，或者說外部如何得到該消息。說明：對于一些涉及到臨界區(qū)操作白接口，一定要注意加以說明。 【2】需要外部提供的接口描述5各功能實體與處理流程說明如果本設(shè)計文檔包括好幾個相對大的功能模塊，則本章可以細分為幾章進行描述，這個時候本章的標題可以是“模塊1各功能實體與處理流程說明”，下一章的標題依此類推。5.1 全局數(shù)據(jù)結(jié)構(gòu)定義與說明描述本系統(tǒng)定義的全局的以及主要的數(shù)據(jù)結(jié)構(gòu)。5.2 主要數(shù)據(jù)結(jié)構(gòu)之間的關(guān)系如果有多個數(shù)據(jù)結(jié)構(gòu)，請說明它們之間的組織關(guān)系。建議使用圖表的形式說明。如果結(jié)構(gòu)比較簡單，那么文字說明要簡潔易懂。5.3 各功能實體以及處理流程說明5.3.1 功能實體1功能1的處理流程說明，可以使用流程圖、UM牌方法進行描述。說明如何實現(xiàn)這些功能，每個步驟是怎樣實現(xiàn)的?？筛鶕?jù)功能再進行細分子實體進行描述。這里有一點需要說明的是：如果本功能實體不再進行進一步分解的總體設(shè)計， 那么這里 必須描述本功能實體對外提供的接口，格式同 4.2節(jié)5.3.2 功能實體26出錯處理設(shè)計6.1 出錯信息用一覽表的方式說朗每種可能的出錯或故障情況出現(xiàn)時，系統(tǒng)輸出信息的形式、含意及處理方法。6.2 出錯處理