軟件概要設(shè)計說明書模版

微信公眾平臺開發(fā)概要設(shè)計說明書軟件概要設(shè)計報告文檔模板1.引言 231.1編寫目的 231.2項目風險 231.3預期讀者和閱讀建議 231.4參考資料 232.設(shè)計概述 242.1限制和約束 242.2設(shè)計原則和設(shè)計要求 243.系統(tǒng)邏輯設(shè)計 253.1系統(tǒng)組織設(shè)計 253.2系統(tǒng)結(jié)構(gòu)設(shè)計 253.2.1系統(tǒng)特性表 263.2.2系統(tǒng)特性結(jié)構(gòu)圖 273.3系統(tǒng)接口設(shè)計 273.3.1系統(tǒng)接口表 273.3.2系統(tǒng)接口傳輸協(xié)議說明 283.4系統(tǒng)完整性設(shè)計 284.系統(tǒng)出錯處理設(shè)計 294.1系統(tǒng)出錯處理表 294.2維護處理過程表 305.技術(shù)設(shè)計 315.1系統(tǒng)開發(fā)技術(shù)說明表 315.2開發(fā)技術(shù)應(yīng)用說明 326.數(shù)據(jù)庫設(shè)計 327.詞匯表 328.進度計劃 321引言編寫目的項目風險風險承擔者有:任務(wù)提出者:軟件開發(fā)者：產(chǎn)品使用者：本軟件系統(tǒng)概要設(shè)計報告針對各種不同的預期讀者，例如，可能的讀者包括：用戶；開發(fā)人員；項目經(jīng)理；營銷人員；測試人員；文檔編寫人員；等等。參考資料列舉編寫軟件產(chǎn)品概要設(shè)計報告時所用到的參考文獻及資料，可能包括：本項目的合同書；上級機關(guān)有關(guān)本項目的批文；本項目已經(jīng)批準的計劃任務(wù)書；用戶界面風格指導；開發(fā)本項目時所要用到的標準；系統(tǒng)規(guī)格需求說明；使用實例文檔；屬于本項目的其它已發(fā)表文件；本軟件系統(tǒng)概要設(shè)計報告中所引用的文件、資料：相關(guān)軟件系統(tǒng)概要設(shè)計報告：等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順排列。如果可能，每份資料都應(yīng)該給出：標題名稱；作者或者合同簽約者；文件編號或者版本號；發(fā)表日期或者簽約日期；出版單位或者資料來源。設(shè)計概述限制和約束簡要描述起到限制和約束作用的各種可能存在的條件，例如：技術(shù)條件：資金狀況：資金有限開發(fā)環(huán)境(包括：工具和平臺)等等。設(shè)計原則和設(shè)計要求描述對本軟件系統(tǒng)進行概要設(shè)計的原則，通?？梢钥紤]以下幾方面的內(nèi)容：命名規(guī)則：邊界設(shè)計原則：數(shù)據(jù)庫設(shè)計規(guī)則：容量大必須的安全措施：一旦數(shù)據(jù)庫崩潰，所有信息都自動備份，并且有恢復功能安全性和保密原則：系統(tǒng)靈活性要求；系統(tǒng)易操作性要求；系統(tǒng)可維護性要求；等等。系統(tǒng)邏輯設(shè)計本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說明書和軟件產(chǎn)品數(shù)據(jù)字典建立系統(tǒng)的邏輯模型。此種模型暫時與系統(tǒng)的物理因素(例如：計算機、數(shù)據(jù)庫管理系統(tǒng))無關(guān)。它是系統(tǒng)需求與物理實現(xiàn)的中間結(jié)構(gòu)，它的主要結(jié)果是建立：系統(tǒng)結(jié)構(gòu)圖、系統(tǒng)界面結(jié)構(gòu)圖、系統(tǒng)出錯處理、以及系統(tǒng)開發(fā)技術(shù)說明。說明：如果進行系統(tǒng)設(shè)計時尚未編寫軟件數(shù)據(jù)字典：應(yīng)首先參照附錄B說明，編寫軟件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后，再進行系統(tǒng)設(shè)計。系統(tǒng)組織設(shè)計系統(tǒng)組織設(shè)計通過系統(tǒng)組織表描述本系統(tǒng)由哪些子系統(tǒng)(模塊)組成，這些子系統(tǒng)與業(yè)務(wù)職能之間的關(guān)系，以及各個子系統(tǒng)的安裝地點。該系統(tǒng)的關(guān)系表如下：子系統(tǒng)編號英文名稱中文名稱業(yè)務(wù)職能安裝地點備注 系統(tǒng)結(jié)構(gòu)設(shè)計本節(jié)將對系統(tǒng)特性作較為詳細的描述，并給出系統(tǒng)特性結(jié)構(gòu)圖。系統(tǒng)特性表系統(tǒng)特性是系統(tǒng)中完成某項具體操作的基本單元，它由入口參數(shù)，出口參數(shù)以及處理過程三部分組成。系統(tǒng)特性可以具有操作界面，也可以沒有操作界面；可以被其它操作界面、或者系統(tǒng)特性調(diào)用，也可以調(diào)用其它操作界面、非操作界面、或者系統(tǒng)特性；但是不允許遞歸調(diào)用(調(diào)用自己)，包括間接遞歸調(diào)用。當系統(tǒng)由多個子系統(tǒng)(模塊)組成時，每個子系統(tǒng)分別使用一張系統(tǒng)特性表進行描述。系統(tǒng)特性表的格式如下：系統(tǒng)特性結(jié)構(gòu)圖系統(tǒng)特性結(jié)構(gòu)圖給出系統(tǒng)特性在邏輯層面上相互之間的關(guān)系，其主要依據(jù)來源于需求規(guī)格說明書中，系統(tǒng)特性一節(jié)中的有關(guān)描述。如果系統(tǒng)劃分為多個子系統(tǒng)，應(yīng)分別給出系統(tǒng)與子系統(tǒng)、以及各個子系統(tǒng)與系統(tǒng)特性的結(jié)構(gòu)圖。繪制系統(tǒng)與子系統(tǒng)結(jié)構(gòu)圖時，一般不需要描繪出系統(tǒng)特性，如果確有必要，盡可能只畫出第一層系統(tǒng)特性。繪制子系統(tǒng)與系統(tǒng)特性結(jié)構(gòu)圖時，通常也不需要描繪出第二層系統(tǒng)特性，如果確有必要可以畫出，但是盡可能不要畫出第三層系統(tǒng)特性。系統(tǒng)接口設(shè)計系統(tǒng)接口是一種非可視的系統(tǒng)界面，在多數(shù)情況下，它對用戶是透明的。本節(jié)將對系統(tǒng)接口作較為詳細的描述，并給出接口說明清單。系統(tǒng)接口表接口作為系統(tǒng)的一種輸入／輸出形式，分為網(wǎng)絡(luò)接口、數(shù)據(jù)庫接口、RS-232串行通訊接口、IEEE—485串行總線接口、并行I/O接口等等多種類型。對于一些為可視界面服務(wù)的接口，例如：打印機接口、顯示器接口等，因為這類接口對應(yīng)用軟件是透明的，所以不在本節(jié)描述范圍內(nèi)。當系統(tǒng)由多個子系統(tǒng)(模塊)組成時，每個子系統(tǒng)分別使用一張系統(tǒng)接口表進行描述。系統(tǒng)接口表的格式如下：子系統(tǒng)編號子系統(tǒng)英文名稱子系統(tǒng)中文名稱接口編號接口名稱接口類型接口性質(zhì)接口速率接口協(xié)議備注說明：系統(tǒng)接口傳輸協(xié)議說明逐項詳細描述系統(tǒng)接口表中所列出各個系統(tǒng)接口使用的傳輸協(xié)議，以及其它相關(guān)內(nèi)容，例如：驅(qū)動程序、動態(tài)連接庫、等等。系統(tǒng)完整性設(shè)計描述系統(tǒng)對象(數(shù)據(jù)元、數(shù)據(jù)類)，所受到的邏輯約束關(guān)系。當系統(tǒng)由多個子系統(tǒng)(模塊)組成時，每個子系統(tǒng)應(yīng)分別使用一張系統(tǒng)完整性約束表進行描述。系統(tǒng)完整性約束表的格式如下：子系統(tǒng)編號子系統(tǒng)英文名稱子系統(tǒng)中文名稱約束編號完整性名稱相對對象名約束表達式備注說明：系統(tǒng)出錯處理設(shè)計本節(jié)描述系統(tǒng)發(fā)生外界及內(nèi)在錯誤時，所提供的錯誤信息及處理方法，它包括系統(tǒng)出錯處理表及維護處理過程表。系統(tǒng)出錯處理表本表給出有關(guān)出錯處理的產(chǎn)生原因、提示信息、以及建議處理方法。當系統(tǒng)由多個子系統(tǒng)(模塊)組成時，每個子系統(tǒng)分別使用一張系統(tǒng)出錯處理表進行描述。系統(tǒng)出錯處理表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯誤編號錯誤名稱錯誤原因錯誤信息處理方式備注說明：維護處理過程表系統(tǒng)出錯時，將調(diào)用維護處理過程對錯誤進行處理，有關(guān)維護處理過程的各項內(nèi)容由維護處理過程表進行描述。當系統(tǒng)有多個子系統(tǒng)(模塊)組成時，每個子系統(tǒng)分別使用一張維護處理過程表進行描述。維護處理過程表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯誤編號處理過程處理過程處理功能入口參數(shù)出口參數(shù)備注英文名稱中文名稱說明：技術(shù)設(shè)計系統(tǒng)技術(shù)設(shè)計描述系統(tǒng)各個特性實際使用的開發(fā)技術(shù)，以及具體開發(fā)技術(shù)使用時應(yīng)該注意的事項。系統(tǒng)開發(fā)技術(shù)說明表本表描述系統(tǒng)各個特性開發(fā)時實際使用的具體技術(shù)，只有一些不太常用的技術(shù)需要在這里描述。一些常用技術(shù)，例如：通過數(shù)據(jù)庫接口調(diào)用存儲過程，則不必冗述。當系統(tǒng)由多個子系統(tǒng)(模塊)組成時，每個子系統(tǒng)分別使用一張系統(tǒng)開發(fā)技術(shù)說明表進行描述。系統(tǒng)開發(fā)技術(shù)說明表的格式如下：子系統(tǒng)編號：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：技術(shù)編號開發(fā)技術(shù)開發(fā)技術(shù)處理功能系統(tǒng)特性編號備注英文名稱中文名稱說明：說明描述與該系統(tǒng)開發(fā)技術(shù)說明表有關(guān)的其它注意事項。開發(fā)技術(shù)應(yīng)用說明逐項詳細描述系統(tǒng)開發(fā)技術(shù)說明表中所列出各項系統(tǒng)開發(fā)技術(shù)使用的技術(shù)要點，以及其它相關(guān)內(nèi)容，例如：所需的服務(wù)、使用的動態(tài)連接庫、調(diào)用的組件、等等。數(shù)據(jù)庫設(shè)計如果該軟件產(chǎn)品需要使用數(shù)據(jù)庫，不論是使用數(shù)據(jù)庫平臺支撐的，還是采用由軟件產(chǎn)品開發(fā)者自行定義的；都應(yīng)該在完成軟件產(chǎn)品需求分析報告后，開始進行軟件產(chǎn)品詳細設(shè)計之前，按照軟件產(chǎn)品數(shù)據(jù)庫設(shè)計說明文檔模板完成數(shù)據(jù)庫設(shè)計工作。詞匯表列出本文件中用到的專業(yè)術(shù)語的定義，以及有關(guān)縮寫