軟體總體設計說明書簡版

2022-05-27 13:15:05 字數 3807 閱讀 1876

目錄1 引言 5

1.1 目的 5

1.2 範圍 5

2 總體概述 5

2.1 指標描述 5

2.2 本系統上下文說明 5

2.2.1軟體結構 5

2.2.2硬體結構(可選) 5

2.3 設計約束 5

2.3.1遵循標準(可選) 5

2.3.2硬體約束(可選) 6

2.3.3其他約束(可選) 6

2.4 其他(可選) 6

3 軟體總體結構 6

3.1 分解檢視 6

3.1.1 分解說明 6

3.1.2 各實體說明 6

3.1.3 初始化/配置說明 6

3.2 執行檢視 6

3.3 開發檢視 7

4 介面說明 7

4.1 使用者介面 7

4.2 外部介面 7

5 各功能實體與處理流程說明 7

5.1 全域性資料結構定義與說明 8

5.2 主要資料結構之間的關係 8

5.3 各功能實體以及處理流程說明 8

5.3.1 功能實體1 8

5.3.2 功能實體2 8

6 出錯處理設計 8

6.1 出錯資訊 8

6.2 出錯處理設計 8

6.3 系統維護設計 9

7開發環境說明 9

8其他 9

軟體總體設計說明書

關鍵詞:

摘要:縮略語說明:

參考資料:

列出本文件的所有參考文獻(包括:正式/非正式出版物、公司/部門文件等),格式如下:

作者+書名(或雜誌、文獻、文件)+出版社(或期號、卷號、公司文件編號)+出版日期

模板使用說明:

[1]註明可選的部分,可以根據實際情況選擇是否填寫;如果不必說明,請務必保留相關的章節標題,同時在該可選章節的內容中填入「無」;未註名可選的,則必須描述;如果有些設計此模版中沒有合適的地方填寫,則補充在最後的其他欄目中

[2]模版中斜體字相當於撰寫指南,最後文稿請將本模板中所有的斜體字部分全部刪除。

[3]模板裡並不說明設計技術和方法,而只是說明應包含哪些內容,以及如何描述、組織這些內容。

[4]對於移植的**,描述可以相對簡單一些,但以下這些章節不能省略:指標描述、本系統上下文說明、初始化/配置說明、開發檢視、介面說明、移植一些說明和考慮可以放在其它一節中

1 引言

說明本設計是為了滿足軟體需求規格說明書中的哪些需求而做的,指明讀者物件

說明文件所包括的內容

2 總體概述

說明本系統或模組所實現的詳細指標

2.2.1軟體結構

簡要說明本系統與外部軟體系統的上下文關係,表示方法可以採用結構圖、資料流圖、uml等。目的是為了描述本系統與外部系統的互動關係。

比如,ppp模組的總體設計,這裡就需要說明ppp與鏈路層框架的關係,ppp與網路層的關係,ppp與aaa的關係等,當然,如果對os有特別需求的話,在這裡也可以進行描述。這裡的描述不是說寫出乙個函式介面的說明,而是對相互關聯關係的說明, 一般包括資料的流向路徑,管理路徑等。

如果用圖不能描述清楚,則請用自然語言補充說明,這裡要求考慮到每個路徑。

2.2.2硬體結構(可選)

此處著重說明本系統依附的硬體架構,對於非驅動類軟體模組,本節可以省略。

這裡的描述格式不做更細的約定,由設計人員自行把握。

2.3.1遵循標準(可選)

描述本系統所遵循的標準、規範。

2.3.2硬體約束(可選)

描述本軟體系統實現的硬體約束,比如,對記憶體的限制等。這是對硬體結構的補充,前面可以說明硬體的總體框架,功能框圖。這兒著重講解硬體對軟體的限制,比如不提供某種訊號導致軟體設計中需要注意的地方或者說限制。

2.3.3其他約束(可選)

描述本軟體系統設計時需要遵循的其它約束。

描述其他有關的設計考慮。

3 軟體總體結構

3.1.1 分解說明

提供本系統(模組)的內部結構圖並加以描述。這裡其實是提供了本系統的乙個分解檢視,乙個系統一般就是由乙個個實體(可以是子模組、資料等)構成。這裡,就是請大家將這個分解檢視描述清楚,可以使用層次分解圖加自然語言的形式加以描述(但不限於此描述方法)。

分解的結果就是能夠清晰地看出本系統由哪些實體組成,以及這些實體間的關聯關係。

3.1.2 各實體說明

簡要說明上述分解檢視中各個實體的功能

3.1.3 初始化/配置說明

說明本系統的初始化依賴關係,也就是說,本系統需要在哪些系統的初始化之後,才能進行初始化。

簡要說明本系統提供了哪些配置項,可以對系統進行相應的配置,以滿足不同的產品需求。

執行說明描述了實體間的關係。執行檢視定義本系統各個實體間互動的關係,並且為理解系統動作是如何執行、、以及在**執行,提供了必要的資訊。它也說明了實體間關係的型別,如共享資訊、預定的執行次序、或者是已定義的引數介面。

要描述本系統由哪些執行緒組成(繪圖),執行緒之間的關係如何,執行緒分別執行在哪個態:核心、應用或中斷態。

軟體工程學中定義的一些表示方法,如資料流圖、uml、流程圖等,都可以用來描述執行檢視。

描述**的組織方式。這裡只需要說明本系統的目錄結構,以及**的目錄(包括公共目錄,頭檔案目錄等)分布。這裡不需要寫出**具體有多少檔案,以及檔名稱等,只要歸類就可以了。

4 介面說明

說明將向使用者提供的命令和它們的語法結構,以及響應資訊。

【1】描述本模組對外提供可以使用的介面說明。介面型別不一定就是函式,可以是api,**,函式指標,也可以是事件、訊息、報文資料、共享記憶體等。描述形式如:

(1) 介面1: 某個api

必須說明以下內容:

宣告:輸入引數描述:

返回值描述:

主要功能描述:描述提供該介面實現的目的;

函式的執行要求:允許在哪個態執行,是否可以重入,以及其他執行要注意的條件。

(2) 介面2:某個訊息

訊息型別:

訊息引數:

訊息目的:描述該訊息的含義和作用

實現方法:描述該訊息如何提供,或者說外部如何得到該訊息。

[說明:對於一些涉及到臨界區操作的介面,一定要注意加以說明。]

【2】需要外部提供的介面描述

5 各功能實體與處理流程說明

如果本設計文件包括好幾個相對大的功能模組,則本章可以細分為幾章進行描述,這個時候本章的標題可以是「模組1各功能實體與處理流程說明」,下一章的標題依此類推。

描述本系統定義的全域性的以及主要的資料結構。

如果有多個資料結構,請說明它們之間的組織關係。

建議使用圖表的形式說明。

如果結構比較簡單,那麼文字說明要簡潔易懂。

5.3.1 功能實體1

功能1的處理流程說明,可以使用流程圖、uml等方法進行描述。

說明如何實現這些功能,每個步驟是怎樣實現的。

可根據功能再進行細分子實體進行描述。

這裡有一點需要說明的是:如果本功能實體不再進行進一步分解的總體設計,那麼這裡必須描述本功能實體對外提供的介面,格式同4.2節

5.3.2 功能實體2

6 出錯處理設計

用一覽表的方式說朗每種可能的出錯或故障情況出現時,系統輸出資訊的形式、含意及處理方法。

說明系統出錯時處理方法,如:資料自動備份、副本的建立和啟動、資料恢復和重啟技術等

說明為了系統維護的方便而在程式內部設計中作出的安排,包括在程式中專門安排用於系統的檢查與維護的檢測點和專用模組。

7開發環境說明

說明本系統的開發環境和開發工具等,有何特別的說明和建議。

8其他其它需要說明的。

總體設計說明書

版本號 目錄1 引言 1 1.1 編寫目的 1 1.2 範圍 1 1.3 定義 1 1.4 參考資料 1 2 總體設計 2 2.1 需求規定 2 2.2 執行環境 2 2.3 基本設計概念和處理流程 2 2.4 結構 2 2.5 功能需求與程式的關係 2 2.6 人工處理過程 3 2.7 尚未解決的...

鑽機總體設計 液壓系統設計說明書

圖1.1 型鑽機總圖 1.固定架 2.夾持卸扣裝置 3.孔口導向裝置 4.80迴轉器 5.液壓馬達 6.73防鬆器 7.單重分流器 50通徑 8.推進架 9.滑架 10.變角機構 11.機架 12.轉盤元件 13.步履機構 14.支撐元件 圖1.2 1.1 鑽機主要用途 鑽機的各組成部分都採用了國內...

圖書管理系統總體設計說明書

基於c s的圖書管理系統 總體設計說明書 專業 軟體工程導論 班級 軟體工程 3 班 姓名 吳禮俊 報告日期 2014.12.25 基於c s的圖書管理系統 總體設計說明書 通過前面的需求設計,從而了解到了系統的需求和資料流圖,要實現系統,就需要對客戶的需求進行分析,以確定對使用者需求的物理配置,以...