軟件概要設(shè)計(jì)報(bào)告文檔模板(共12頁)

1、精選優(yōu)質(zhì)文檔-傾情為你奉上軟件概要設(shè)計(jì)報(bào)告文檔模板1. 引言引言是對這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔是如何編寫的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。1.1 編寫目的說明這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求規(guī)格說明書編寫的，開發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告詳盡說明了該軟件產(chǎn)品的軟件結(jié)構(gòu)，包括數(shù)據(jù)庫結(jié)構(gòu)和出錯(cuò)處理，從而對該軟件產(chǎn)品的結(jié)構(gòu)的描述。如果這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義軟件系統(tǒng)概要設(shè)計(jì)報(bào)告中說明的那個(gè)部分或子系統(tǒng)。1.2 項(xiàng)目風(fēng)險(xiǎn)具體說明本軟件開發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，

2、以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括： 任務(wù)提出者； 軟件開發(fā)者； 產(chǎn)品使用者。1.3 預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告所針對的各種不同的預(yù)期讀者，例如，可能的讀者包括： 用戶； 開發(fā)人員； 項(xiàng)目經(jīng)理； 營銷人員； 測試人員； 文檔編寫人員； 等等。描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對每一類讀者提出最適合的文檔閱讀建議。1.4 參考資料列舉編寫軟件產(chǎn)品概要設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括： 本項(xiàng)目的合同書； 上級機(jī)關(guān)有關(guān)本項(xiàng)目的批文； 本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書； 用戶界面風(fēng)格指導(dǎo)； 開發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)準(zhǔn)； 系統(tǒng)規(guī)格需求說明； 使用實(shí)

3、例文檔； 屬于本項(xiàng)目的其它已發(fā)表文件； 本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告中所引用的文件、資料： 相關(guān)軟件系統(tǒng)概要設(shè)計(jì)報(bào)告： 等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順排列。如果可能，每份資料都應(yīng)該給出： 標(biāo)題名稱； 作者或者合同簽約者； 文件編號或者版本號； 發(fā)表日期或者簽約日期； 出版單位或者資料來源。2. 設(shè)計(jì)概述本節(jié)描述現(xiàn)有開發(fā)條件和需要實(shí)現(xiàn)的目標(biāo)，說明進(jìn)行概要設(shè)計(jì)時(shí)應(yīng)該遵循的設(shè)計(jì)原則和必須采用的設(shè)計(jì)方法。2.1 限制和約束簡要描述起到限制和約束作用的各種可能存在的條件，例如： 技術(shù)條件； 資金狀況； 開發(fā)環(huán)境(包括：工具和平臺)； 時(shí)間限制； 等等。并且說明在上述條件下，應(yīng)該實(shí)現(xiàn)的系統(tǒng)目標(biāo)

4、，2.2 設(shè)計(jì)原則和設(shè)計(jì)要求描述對本軟件系統(tǒng)進(jìn)行概要設(shè)計(jì)的原則，通?？梢钥紤]以下幾方面的內(nèi)容： 命名規(guī)則； 模塊獨(dú)立性原則： 邊界設(shè)計(jì)原則； 數(shù)據(jù)庫設(shè)計(jì)規(guī)則； 必須的安全措施； 安全性和保密原則； 系統(tǒng)靈活性要求； 系統(tǒng)易操作性要求； 系統(tǒng)可維護(hù)性要求； 等等。3. 系統(tǒng)邏輯設(shè)計(jì)本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說明書和軟件產(chǎn)品數(shù)據(jù)字典建立系統(tǒng)的邏輯模型。此種模型暫時(shí)與系統(tǒng)的物理因素(例如：計(jì)算機(jī)、數(shù)據(jù)庫管理系統(tǒng))無關(guān)。它是系統(tǒng)需求與物理實(shí)現(xiàn)的中間結(jié)構(gòu)，它的主要結(jié)果是建立：系統(tǒng)結(jié)構(gòu)圖、系統(tǒng)界面結(jié)構(gòu)圖、系統(tǒng)出錯(cuò)處理、以及系統(tǒng)開發(fā)技術(shù)說明。說明：如果進(jìn)行系統(tǒng)設(shè)計(jì)時(shí)尚未編寫軟件數(shù)據(jù)字典：應(yīng)首先參照附錄

5、B說明，編寫軟件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后，再進(jìn)行系統(tǒng)設(shè)計(jì)。3.1 系統(tǒng)組織設(shè)計(jì)系統(tǒng)組織設(shè)計(jì)通過系統(tǒng)組織表描述本系統(tǒng)由哪些子系統(tǒng)(模塊)組成，這些子系統(tǒng)與業(yè)務(wù)職能之間的關(guān)系，以及各個(gè)子系統(tǒng)的安裝地點(diǎn)。系統(tǒng)組織表的格式如下：子系統(tǒng)編號英文名稱中文名稱業(yè)務(wù)職能安裝地點(diǎn)備注其中： 子系統(tǒng)編號給出本系統(tǒng)中指定子系統(tǒng)的順序編號。如果本系統(tǒng)末劃分為多個(gè)子系統(tǒng)，僅由一個(gè)運(yùn)行模塊組成；則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。說明：在一個(gè)系統(tǒng)中有可能安裝若干個(gè)相同的子系統(tǒng)，在這種情況下，應(yīng)該視為一個(gè)子系統(tǒng)，并且對多個(gè)安裝地點(diǎn)分別進(jìn)行描述。如果相同的子系統(tǒng)通過系統(tǒng)設(shè)置，實(shí)現(xiàn)的業(yè)務(wù)職能具有明顯差異時(shí)，應(yīng)該采

6、用多行進(jìn)行分別描述，并且在備注中說明其差異所在。 子系統(tǒng)英文名稱給出本子系統(tǒng)的英文名稱，該名稱是在應(yīng)用軟件中實(shí)際使用的可執(zhí)行文件名稱，必須能夠說明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng)，則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。 子系統(tǒng)中文名稱給出本子系統(tǒng)的中文名稱，該名稱必須能夠說明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng)，則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。 業(yè)務(wù)職能描述該子系統(tǒng)完成的核心業(yè)務(wù)。 安裝地點(diǎn)描述該子系統(tǒng)實(shí)際安裝的部門、或者某個(gè)具體地點(diǎn)。 備注針對該子系統(tǒng)，需要說明的其它有關(guān)問題。3.2 系統(tǒng)結(jié)構(gòu)設(shè)計(jì)本節(jié)將對系統(tǒng)特性作較為詳細(xì)的描述，并給出系統(tǒng)特性結(jié)構(gòu)圖。3.2.1

7、 系統(tǒng)特性表系統(tǒng)特性是系統(tǒng)中完成某項(xiàng)具體操作的基本單元，它由入口參數(shù)，出口參數(shù)以及處理過程三部分組成。系統(tǒng)特性可以具有操作界面，也可以沒有操作界面；可以被其它操作界面、或者系統(tǒng)特性調(diào)用，也可以調(diào)用其它操作界面、非操作界面、或者系統(tǒng)特性；但是不允許遞歸調(diào)用(調(diào)用自己)，包括間接遞歸調(diào)用。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)特性表進(jìn)行描述。系統(tǒng)特性表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：特性編號系統(tǒng)特征英文名稱系統(tǒng)特征中文名稱操作功能調(diào)用對象被調(diào)用對象備注說明：其中 子系統(tǒng)編號含義同上。 子系統(tǒng)英文名稱含義同上。 子系統(tǒng)中文名稱含義同上。 特性編號整個(gè)系統(tǒng)

8、所有特性的統(tǒng)一編號。 系統(tǒng)特性英文名稱系統(tǒng)特性的英文正式名稱，將來用于軟件開發(fā)中，必須符合命名規(guī)范。 系統(tǒng)特性中文名稱系統(tǒng)特性的中文正式名稱，來源于需求規(guī)格說明書中，系統(tǒng)特性一節(jié)中的有關(guān)描述。 操作功能是指該特性實(shí)際完成的操作說明。 調(diào)用對象是指調(diào)用該系統(tǒng)特性的系統(tǒng)對象，這里的系統(tǒng)對象可以是系統(tǒng)特性、也可以是操作界面。 被調(diào)用對象是指被該系統(tǒng)特性調(diào)用的系統(tǒng)對象，這里的系統(tǒng)對象可以是系統(tǒng)特性、也可以是操作界面。說明：某些較低層的系統(tǒng)特性，可能不存在被調(diào)用對象。 備注描述與該系統(tǒng)特性有關(guān)的其它注意事項(xiàng)。 說明描述與該系統(tǒng)特性表有關(guān)的其它注意事項(xiàng)。3.2.2 系統(tǒng)特性結(jié)構(gòu)圖系統(tǒng)特性結(jié)構(gòu)圖給出系統(tǒng)特性

9、在邏輯層面上相互之間的關(guān)系，其主要依據(jù)來源于需求規(guī)格說明書中，系統(tǒng)特性一節(jié)中的有關(guān)描述。如果系統(tǒng)劃分為多個(gè)子系統(tǒng)，應(yīng)分別給出系統(tǒng)與子系統(tǒng)、以及各個(gè)子系統(tǒng)與系統(tǒng)特性的結(jié)構(gòu)圖。繪制系統(tǒng)與子系統(tǒng)結(jié)構(gòu)圖時(shí)，一般不需要描繪出系統(tǒng)特性，如果確有必要，盡可能只畫出第一層系統(tǒng)特性。繪制子系統(tǒng)與系統(tǒng)特性結(jié)構(gòu)圖時(shí)，通常也不需要描繪出第二層系統(tǒng)特性，如果確有必要可以畫出，但是盡可能不要畫出第三層系統(tǒng)特性。3.3 系統(tǒng)接口設(shè)計(jì)系統(tǒng)接口是一種非可視的系統(tǒng)界面，在多數(shù)情況下，它對用戶是透明的。本節(jié)將對系統(tǒng)接口作較為詳細(xì)的描述，并給出接口說明清單。3.3.1 系統(tǒng)接口表接口作為系統(tǒng)的一種輸入輸出形式，分為網(wǎng)絡(luò)接口、數(shù)據(jù)庫接

10、口、RS-232串行通訊接口、IEEE485串行總線接口、并行I/O接口等等多種類型。對于一些為可視界面服務(wù)的接口，例如：打印機(jī)接口、顯示器接口等，因?yàn)檫@類接口對應(yīng)用軟件是透明的，所以不在本節(jié)描述范圍內(nèi)。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)接口表進(jìn)行描述。系統(tǒng)接口表的格式如下：子系統(tǒng)編號子系統(tǒng)英文名稱子系統(tǒng)中文名稱接口編號接口名稱接口類型接口性質(zhì)接口速率接口協(xié)議備注說明：其中： 子系統(tǒng)編號含義同上。 子系統(tǒng)英文名稱含義同上。 子系統(tǒng)中文名稱含義同上。 接口編號整個(gè)系統(tǒng)所有接口的統(tǒng)一編號。 接口名稱系統(tǒng)接口的正式名稱，必須符合通常習(xí)慣。 接口類型指出該接口所傳輸?shù)臄?shù)據(jù)在該

11、模塊中起到的作用。 接口性質(zhì)指出該接口在通訊中起到的作用，這里的作用可以是：n 輸入；n 輸出；n 雙向。 接口速率指出該接口的傳輸速率。如果該接口依賴于其它通訊方式，那么傳輸速率將不高于它所依賴的其它通訊方式的速率。 接口協(xié)議給出該接口實(shí)際使用的通訊協(xié)議。 相關(guān)對象給出直接使用本接口的系統(tǒng)對象，這里的系統(tǒng)對象，可以是操作界面，也可以是系統(tǒng)特性。 備注描述與該系統(tǒng)接口有關(guān)的其它注意事項(xiàng)。 說明描述與該系統(tǒng)接口表有關(guān)的其它注意事項(xiàng)。3.3.2 系統(tǒng)接口傳輸協(xié)議說明逐項(xiàng)詳細(xì)描述系統(tǒng)接口表中所列出各個(gè)系統(tǒng)接口使用的傳輸協(xié)議，以及其它相關(guān)內(nèi)容，例如：驅(qū)動(dòng)程序、動(dòng)態(tài)連接庫、等等。3.4 系統(tǒng)完整性設(shè)計(jì)描

12、述系統(tǒng)對象(數(shù)據(jù)元、數(shù)據(jù)類)，所受到的邏輯約束關(guān)系。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)應(yīng)分別使用一張系統(tǒng)完整性約束表進(jìn)行描述。系統(tǒng)完整性約束表的格式如下：子系統(tǒng)編號子系統(tǒng)英文名稱子系統(tǒng)中文名稱約束編號完整性名稱相對對象名約束表達(dá)式備注說明：其中： 子系統(tǒng)編號含義同上。 子系統(tǒng)英文名稱含義同上。 子系統(tǒng)中文名稱含義同上。 約束編號整個(gè)系統(tǒng)所有約束的統(tǒng)一編號。 完整性名稱系統(tǒng)完整性約束的正式名稱，必須符合通常習(xí)慣。 相對對象名完整性約束中的相關(guān)對象(數(shù)據(jù)元和數(shù)據(jù)類)。 約束表達(dá)式用一階邏輯表達(dá)式表達(dá)的約束方程式。 備注描述與該系統(tǒng)完整性約束有關(guān)的其它注意事項(xiàng)。 說明描述與該系統(tǒng)完整性約束

13、表有關(guān)的其它注意事項(xiàng)。4. 系統(tǒng)出錯(cuò)處理設(shè)計(jì)本節(jié)描述系統(tǒng)發(fā)生外界及內(nèi)在錯(cuò)誤時(shí)，所提供的錯(cuò)誤信息及處理方法，它包括系統(tǒng)出錯(cuò)處理表及維護(hù)處理過程表。4.1 系統(tǒng)出錯(cuò)處理表本表給出有關(guān)出錯(cuò)處理的產(chǎn)生原因、提示信息、以及建議處理方法。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)出錯(cuò)處理表進(jìn)行描述。系統(tǒng)出錯(cuò)處理表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯(cuò)誤編號錯(cuò)誤名稱錯(cuò)誤原因錯(cuò)誤信息處理方式備注說明：其中： 子系統(tǒng)編號含義同上。 子系統(tǒng)英文名稱含義同上。 子系統(tǒng)中文名稱含義同上。 錯(cuò)誤編號整個(gè)系統(tǒng)所有錯(cuò)誤的統(tǒng)一編號。 錯(cuò)誤名稱錯(cuò)誤的正式名稱，該名稱應(yīng)該是常用的，并且為人們

14、所普遍接受的。 錯(cuò)誤原因?qū)υ撳e(cuò)誤產(chǎn)生原因的解釋與說明。 錯(cuò)誤信息產(chǎn)生該錯(cuò)誤時(shí)，向用戶發(fā)出的提示信息。 處理方式對該錯(cuò)誤處理的一種建議，此項(xiàng)允許缺省。 備注描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。 說明描述與該系統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。4.2 維護(hù)處理過程表系統(tǒng)出錯(cuò)時(shí)，將調(diào)用維護(hù)處理過程對錯(cuò)誤進(jìn)行處理，有關(guān)維護(hù)處理過程的各項(xiàng)內(nèi)容由維護(hù)處理過程表進(jìn)行描述。當(dāng)系統(tǒng)有多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張維護(hù)處理過程表進(jìn)行描述。維護(hù)處理過程表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯(cuò)誤編號處理過程處理過程處理功能入口參數(shù)出口參數(shù)備注英文名稱中文名稱說明：其中： 子系統(tǒng)編號含義

15、同上。 子系統(tǒng)英文名稱含義同上。 子系統(tǒng)中文名稱含義同上。 錯(cuò)誤編號含義同上。 處理過程英文名稱系統(tǒng)維護(hù)處理過程的英文正式名稱，將來用于軟件開發(fā)中，必須符合命名規(guī)范。 處理過程中文名稱系統(tǒng)維護(hù)處理過程的中文正式名稱，是系統(tǒng)維護(hù)處理過程英文名稱的中文說明。 處理功能描述本維護(hù)處理過程對錯(cuò)誤的處理方式。由于一個(gè)維護(hù)處理過程有可能具有對多個(gè)錯(cuò)誤進(jìn)行處理的能力，因此該處理功能必須是針對本項(xiàng)錯(cuò)誤編號的。 入口參數(shù)進(jìn)行本項(xiàng)錯(cuò)誤處理時(shí)，賦給維護(hù)處理過程的入口參數(shù)。 出口參數(shù)進(jìn)行本項(xiàng)錯(cuò)誤處理時(shí)，維護(hù)處理過程返回的出口參數(shù)。 備注描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。 說明描述與該系統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。5

16、. 技術(shù)設(shè)計(jì)系統(tǒng)技術(shù)設(shè)計(jì)描述系統(tǒng)各個(gè)特性實(shí)際使用的開發(fā)技術(shù)，以及具體開發(fā)技術(shù)使用時(shí)應(yīng)該注意的事項(xiàng)。5.1 系統(tǒng)開發(fā)技術(shù)說明表本表描述系統(tǒng)各個(gè)特性開發(fā)時(shí)實(shí)際使用的具體技術(shù)，只有一些不太常用的技術(shù)需要在這里描述。一些常用技術(shù)，例如：通過數(shù)據(jù)庫接口調(diào)用存儲(chǔ)過程，則不必冗述。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)開發(fā)技術(shù)說明表進(jìn)行描述。系統(tǒng)開發(fā)技術(shù)說明表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：技術(shù)編號開發(fā)技術(shù)開發(fā)技術(shù)處理功能系統(tǒng)特性編號備注英文名稱中文名稱說明：其中： 子系統(tǒng)編號含義同上。 子系統(tǒng)英文名稱含義同上。 子系統(tǒng)中文名稱含義同上。 技術(shù)編號這個(gè)系統(tǒng)所使用

17、各種技術(shù)的統(tǒng)一編號。 開發(fā)技術(shù)英文名稱該開發(fā)技術(shù)的英文正式名稱，可以便用縮寫。該名稱應(yīng)該是常用的，并且為人們所普遍接受的。 開發(fā)技術(shù)中文名稱該開發(fā)技術(shù)的中文正式名稱，是該開發(fā)技術(shù)英文名稱的中文說明。該名稱應(yīng)該是常用的，并且為人們所普遍接受的。 處理功能描述本開發(fā)技術(shù)的處理目的。 系統(tǒng)特性編號含義同上。由于一項(xiàng)開發(fā)技術(shù)可能在多處使用，因此針對一項(xiàng)開發(fā)技術(shù)，有可能存在多個(gè)系統(tǒng)特性編號，在此必須一一列出。 備注描述與該系統(tǒng)開發(fā)技術(shù)相關(guān)的其它注意事項(xiàng)。 說明描述與該系統(tǒng)開發(fā)技術(shù)說明表有關(guān)的其它注意事項(xiàng)。5.2 開發(fā)技術(shù)應(yīng)用說明逐項(xiàng)詳細(xì)描述系統(tǒng)開發(fā)技術(shù)說明表中所列出各項(xiàng)系統(tǒng)開發(fā)技術(shù)使用的技術(shù)要點(diǎn)，以及其它相關(guān)內(nèi)容，例如：所需的服務(wù)、使用的動(dòng)態(tài)連接庫、調(diào)用的組件、等等。6. 數(shù)據(jù)庫設(shè)計(jì)如果該軟件產(chǎn)品需要使用數(shù)據(jù)庫，不論是使用數(shù)據(jù)庫平臺支撐的，還是采用由軟件產(chǎn)品開發(fā)者自行定義的；都應(yīng)該在完成軟件產(chǎn)品需求分析報(bào)告后，開始進(jìn)行軟件產(chǎn)