軟件工程標(biāo)準(zhǔn)文檔模板—概要設(shè)計說明書.doc

項目編號項目編號 S 卷卷 號號 卷內(nèi)編號卷內(nèi)編號 密密 級級 概要設(shè)計說明書概要設(shè)計說明書 Version 項 目 承 擔(dān) 部 門 撰 寫 人 簽名 完 成 日 期 本文檔 使 用部門 主管領(lǐng)導(dǎo) 項目組 客戶 市場 維護(hù)人員 用戶 評審負(fù)責(zé)人 簽名 評 審 日 期 分 類 修改日志修改日志 修改者修改日期備注說明 概要設(shè)計說明書 1 目 錄 1 引言引言 1 1 1編寫目的 1 1 2定義 1 1 3參考資料 1 2 范圍范圍 1 2 1系統(tǒng)主要目標(biāo) 1 2 2主要軟件需求 1 2 3設(shè)計約束 限制 1 3 軟件系統(tǒng)結(jié)構(gòu)設(shè)計軟件系統(tǒng)結(jié)構(gòu)設(shè)計 1 3 1復(fù)審數(shù)據(jù)流 控制流 1 3 2軟件體系結(jié)構(gòu) 1 3 2 1軟件程序結(jié)構(gòu)圖 1 3 2 2模塊命名規(guī)則 2 3 2 3模塊描述 2 3 3功能需求追溯 2 3 4復(fù)用策略 2 4 數(shù)據(jù)設(shè)計數(shù)據(jù)設(shè)計 3 4 1數(shù)據(jù)字典復(fù)審 3 4 2數(shù)據(jù)項 3 4 3數(shù)據(jù)庫結(jié)構(gòu)設(shè)計 3 4 4數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 3 4 5文件設(shè)計 3 5 接口設(shè)計接口設(shè)計 3 5 1用戶界面設(shè)計規(guī)則 3 5 2內(nèi)部接口設(shè)計 3 5 3外部接口設(shè)計 3 6 出錯處理設(shè)計出錯處理設(shè)計 3 7 系統(tǒng)維護(hù)設(shè)計系統(tǒng)維護(hù)設(shè)計 4 概要設(shè)計說明書 2 1 引言引言 1 1 編寫目的編寫目的 說明編寫這份概要設(shè)計說明書的目的 并指出預(yù)期的讀者 1 2 定義定義 列出文件中用到的專門術(shù)語的定義和外文首字母的原詞組 1 3 參考資料參考資料 列出用的著的參考資料 如 本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同 上級機(jī)關(guān)的批文 屬于本項目的其他已發(fā)表的文件 本文件中各處引用的文件 資料 包括所需用到的軟件開發(fā)標(biāo)準(zhǔn) 2 范圍范圍 對 需求規(guī)格說明書 進(jìn)行復(fù)審 如有變更需要在本節(jié)進(jìn)行說明 以下內(nèi)容描述軟件概要設(shè)計的整體范圍 其主要信息來自于 需求規(guī)格說明書 2 1 系統(tǒng)主要目標(biāo)系統(tǒng)主要目標(biāo) 2 2 主要軟件需求主要軟件需求 2 3 設(shè)計約束 限制設(shè)計約束 限制 3 軟件系統(tǒng)結(jié)構(gòu)設(shè)計軟件系統(tǒng)結(jié)構(gòu)設(shè)計 3 1 復(fù)審數(shù)據(jù)流 控制流復(fù)審數(shù)據(jù)流 控制流 復(fù)審需求分析階段對軟件的功能需求的描述 如系統(tǒng)的DFD圖和IDEF0圖 是否合理和精化 否則 應(yīng)在本節(jié)進(jìn)行進(jìn)一步分解和精化 3 2 軟件體系結(jié)構(gòu)軟件體系結(jié)構(gòu) 通過變換映射 如基于DFD或基于IDEF0 的結(jié)構(gòu)設(shè)計 并采用適當(dāng)?shù)膬?yōu)化準(zhǔn)則進(jìn)行軟件 結(jié)構(gòu)的優(yōu)化 該過程可在本節(jié)中分段落進(jìn)行描述 已得到優(yōu)化的軟件體系結(jié)構(gòu)用結(jié)構(gòu)圖 Structure Chart 進(jìn)行描述 描述的內(nèi)容包括 3 2 1軟件程序結(jié)構(gòu)圖 畫出軟件體系結(jié)構(gòu)的樹狀層次 概要設(shè)計說明書 3 3 2 2模塊命名規(guī)則 給出軟件模塊的命名規(guī)則 保證模塊名稱在項目內(nèi)的唯一性和無二義性 3 2 3模塊描述 可用IPO圖結(jié)合下表對每一軟件模塊進(jìn)行描述 名 稱標(biāo)識 子系統(tǒng) 名 稱 系統(tǒng) 名稱 輸入接 口 說 明輸出 功 能 說 明 運行環(huán) 境說明 簡要地說明對本模塊的運行環(huán)境 包括硬件環(huán)境和支持環(huán)境 的規(guī)定 調(diào)用模塊調(diào)用關(guān) 系說明被調(diào)用模塊 3 3 功能需求追溯功能需求追溯 本節(jié)說明 需求規(guī)格說明書 中的各項功能需求已在軟件體系結(jié)構(gòu)中得到分配 可用如下的二維表說明各項功能需求與軟件模塊的對應(yīng)關(guān)系 模塊 1模塊 2 模塊 M 功能需求 1 功能需求 2 功能需求 m 此表可以采用其他適用形式 如拆分為兩張表 功能需求對應(yīng)模塊 模塊對應(yīng)功能需求 對應(yīng)的模塊 功能需求 1 功能需求 m 對應(yīng)的功能需求 模塊 1 模塊 m 3 4 復(fù)用策略復(fù)用策略 說明軟件可復(fù)用的數(shù)據(jù) 接口和模塊 復(fù)用既指可利用的現(xiàn)有構(gòu)件資源 也指軟件中可抽取的 新建構(gòu)件 概要設(shè)計說明書 4 4 數(shù)據(jù)設(shè)計數(shù)據(jù)設(shè)計 本章對軟件所使用的數(shù)據(jù)進(jìn)行定義和概要設(shè)計 本章內(nèi)容在項目的其他文檔中若有描述 請在 相應(yīng)小節(jié)指明 4 1 數(shù)據(jù)字典復(fù)審數(shù)據(jù)字典復(fù)審 對需求分析階段形成的數(shù)據(jù)字典進(jìn)行復(fù)審和精化 4 2 數(shù)據(jù)項數(shù)據(jù)項 定義軟件使用的數(shù)據(jù)項 可能包括 名稱 簡稱 類型 長度 別名等 4 3 數(shù)據(jù)庫結(jié)構(gòu)設(shè)計數(shù)據(jù)庫結(jié)構(gòu)設(shè)計 將需求分析階段形成的實體模型轉(zhuǎn)化為數(shù)據(jù)庫系統(tǒng)支持的數(shù)據(jù)庫模型 如根據(jù)E R圖或 IDEF1x圖建立數(shù)據(jù)庫的物理模型 4 4 數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系 給出本系統(tǒng)內(nèi)所使用的每個數(shù)據(jù)結(jié)構(gòu)的名稱 標(biāo)識符 說明各個數(shù)據(jù)結(jié)構(gòu)與訪問這些數(shù)據(jù)結(jié)構(gòu) 的各個程序模塊間的對應(yīng)關(guān)系 可采用如下的矩陣圖的形式 模塊 1模塊 2 模塊 M 數(shù)據(jù)結(jié)構(gòu) 1 數(shù)據(jù)結(jié)構(gòu) 2 數(shù)據(jù)結(jié)構(gòu) m 4 5 文件設(shè)計文件設(shè)計 說明數(shù)據(jù)存儲文件的邏輯結(jié)構(gòu) 文件組織方式 容量 存取權(quán)限等 5 接口設(shè)計接口設(shè)計 5 1 用戶界面設(shè)計規(guī)則用戶界面設(shè)計規(guī)則 分析 需求規(guī)格說明書 中的用戶特點 設(shè)計交互 信息顯示和數(shù)據(jù)輸入等用戶界面規(guī)則 若 有的話 列出用戶的強制標(biāo)準(zhǔn)和開發(fā)單位的強制標(biāo)準(zhǔn) 5 2 內(nèi)部接口設(shè)計內(nèi)部接口設(shè)計 說明軟件內(nèi)部模塊間的接口安排 5 3 外部接口設(shè)計外部接口設(shè)計 說明本系統(tǒng)同外界的所有接口的安排 包括軟件與硬件之間的接口 本系統(tǒng)與各支持軟件之間 的接口關(guān)系 內(nèi)部和外部的接口設(shè)計必須結(jié)合模塊內(nèi)部的數(shù)據(jù)驗證和出錯處理 6 出錯處理設(shè)計出錯處理設(shè)計 說明每種可能的出錯或