《《概要設(shè)計》模板》由會員分享,可在線閱讀,更多相關(guān)《《概要設(shè)計》模板(7頁珍藏版)》請在裝配圖網(wǎng)上搜索。
1、概要設(shè)計
(完整 word 版)《概要設(shè)計》模板
1.導(dǎo)言
本章對該文檔的目的、功能范圍、術(shù)語、相關(guān)文檔、參考資料、版本更新進(jìn)行說明.
1.1 目的
本文檔的目的旨在推動軟件工程的規(guī)范化,使設(shè)計人員遵循統(tǒng)一的概要設(shè)計書寫規(guī)范,節(jié)省制作文檔的 時間,降低系統(tǒng)實現(xiàn)的風(fēng)險,做到系統(tǒng)設(shè)計資料的規(guī)范性與全面性,以利于系統(tǒng)的實現(xiàn)、測試、維護(hù)、版本 升級等。
1.2 范圍
本文檔用于軟件設(shè)計階段的概要設(shè)計 ,它的上游是《需求分析規(guī)格書》,下游是《詳細(xì)設(shè)計說明書》,并 為《詳細(xì)設(shè)計說明書》提供測試的依據(jù).
軟件概要設(shè)計的范圍是:軟件系統(tǒng)總體結(jié)構(gòu)設(shè)計、全局?jǐn)?shù)據(jù)庫和數(shù)
2、據(jù)結(jié)構(gòu)設(shè)計、外部接口設(shè)計、主要部 件功能分配設(shè)計、部件之間的接口設(shè)計等方面的內(nèi)容。該范圍應(yīng)覆蓋《需求規(guī)格說明書》中的功能點(diǎn)列表、 性能點(diǎn)列表、接口列表。
1.3 命名規(guī)則
變量對象命名規(guī)則:申明全局變量、局部變量對象的命名規(guī)則.
數(shù)據(jù)庫對象命名規(guī)則:申明數(shù)據(jù)庫表名、字段名、索引名、視圖名等對象的命名規(guī)則。
1.4 術(shù)語定義
術(shù)語定義或解釋一般用表格形式給出,如表錯誤!未定義書簽。所示.
表錯誤 !未定義書簽。 術(shù)語定義或解釋表
序號 術(shù)語名稱
術(shù)語定義
1 總體結(jié)構(gòu) 軟件系統(tǒng)的總體邏輯結(jié)構(gòu)。為—樹形的功能模塊結(jié)構(gòu)圖。
本軟件系統(tǒng)與其他軟件系統(tǒng)之間的
3、接口,接口設(shè)施可以是中間
2 外部接口 件。接口描述包括:傳輸方式、帶寬、數(shù)據(jù)結(jié)構(gòu)、傳輸頻率、
傳輸量、傳輸協(xié)議
3 數(shù)據(jù)結(jié)構(gòu) 數(shù)據(jù)結(jié)構(gòu)包括:數(shù)據(jù)庫表的結(jié)構(gòu)、其他數(shù)據(jù)結(jié)構(gòu)等
4
5
概念數(shù)據(jù) 關(guān)系數(shù)據(jù)庫的邏輯設(shè)計模型,叫做概念數(shù)據(jù)模型;主要內(nèi)容包 模型 CDM 括—張邏輯 E-R 圖及其相應(yīng)的數(shù)據(jù)字典
物理數(shù)據(jù) 關(guān)系數(shù)據(jù)庫的物理設(shè)計模型,叫做物理數(shù)據(jù)模型。主要內(nèi)容包 模型 PDM 括一張物理表關(guān)系圖及其相應(yīng)的數(shù)據(jù)字典
6 視圖
在基表或其他視圖之上建立的一張?zhí)摫?,叫做視圖,它具有物 理表的許多性質(zhì),在數(shù)據(jù)處理和授權(quán)上很有用
7
角色
4、
數(shù)據(jù)庫中享有某些特權(quán)操作的用戶,叫做角色。角色的權(quán)利通 過授權(quán)來實現(xiàn)
8
9
10
11
12
子系統(tǒng)
模塊
內(nèi)部接口
相關(guān)文件
參考資料
(完整 word 版)《概要設(shè)計》模板
具有相對獨(dú)立功能的小系統(tǒng)叫做子系統(tǒng);一個大的軟件系統(tǒng)可
以劃分為多個子系統(tǒng),每個子系統(tǒng)可由多個模塊或多個部件組
成
具有功能獨(dú)立、能被調(diào)用的信息單元叫做模塊。
軟件系統(tǒng)內(nèi)部各子系統(tǒng)之間、各部件之間、各模板之間的接口,
叫做內(nèi)部接口。接口描述包括:調(diào)用方式、入口信息、出口信
息等
指當(dāng)本文件內(nèi)容變更后,可能引起變更的其他文件。
5、如需求分
析報告、計細(xì)設(shè)計說明書、測試計劃、用戶手冊
指本文件書寫時用到的其他資料.如各種有關(guān)規(guī)范、模板、標(biāo)準(zhǔn)、
準(zhǔn)則
1.5 參考資科
[l]需求規(guī)格說明書
[2]軟件開發(fā)合同
[3]數(shù)據(jù)庫設(shè)計規(guī)范
[4]命名規(guī)范
1.6 相關(guān)文檔
[1]《詳細(xì)設(shè)計說明書》
[2]源程序清單
[3]測試計劃及報告
[4]《用戶使用手冊》
1.7 版本更新記錄
版本更新記錄格式,如表錯誤!未定義書簽。所示。
表錯誤 !未定義書簽。 版本更新記錄
版本號
創(chuàng)建者
創(chuàng)建日期 維護(hù)者 維護(hù)日期 維護(hù)紀(jì)要
2.總體設(shè)計
2。1
6、總體結(jié)構(gòu)設(shè)計
軟件系統(tǒng)的總體邏輯結(jié)構(gòu),按照不同的設(shè)計方法,有不同的總體邏輯結(jié)構(gòu)。對于結(jié)構(gòu)化設(shè)計方法,畫出 系統(tǒng)總體結(jié)構(gòu)圖,列出系統(tǒng)的功能模塊清單編號、名稱、功能,并盡可能描繪出功能能模塊之間的關(guān)系。
總體結(jié)構(gòu)示意圖,如圖 1 所示(也可畫成豎向的)
(完整 word 版)《概要設(shè)計》模板
圖 1 總體結(jié)構(gòu)示意圖
2.2 運(yùn)行環(huán)境設(shè)計
該軟件系統(tǒng)的運(yùn)行環(huán)境:
硬件平臺:
(1)服務(wù)器的最低配置要求
(2)工作站的最低配置要求
(3)外設(shè)的要求
軟件平臺:
(1)服務(wù)器操作系統(tǒng)
(2)數(shù)據(jù)庫管理系統(tǒng)
(3)中間件
(4)客戶端的操作系統(tǒng)
7、(5)客戶端的平臺軟件
網(wǎng)絡(luò)平臺:
(1)通信協(xié)議
(2)通信帶寬
2.3 子系統(tǒng)清單
子系統(tǒng)清單,如表錯誤!未定義書簽。所示
表錯誤 !未定義書簽。 子系統(tǒng)清單
子系統(tǒng)編號 SS1
SS2
SS3
子系統(tǒng)英文名
子系統(tǒng)功能簡述 子系統(tǒng)之間的關(guān)系
2.4 功能模塊清單
功能模塊清單,如表 1 所示
模塊編號
M1—
1
模塊英文名
表 1 功能模塊清單
模塊功能簡述 模塊的接口簡述
(完整 word 版)《概要設(shè)計》模板
M1-2
M2—
1
3.模塊功能分配
具有功能獨(dú)立,能被調(diào)用的
8、信息單元叫做模塊。模塊是結(jié)構(gòu)化設(shè)計中的概念,模塊功能分配的目的,就 是為了將具有相同功能的模塊合并,從中提取公用模塊,形成公用部件,按照構(gòu)件或中間件的方式加以實現(xiàn), 作為本系統(tǒng)的公用資源,甚至作為公司級組織的公用資源 ,從而充實公司級的構(gòu)件庫或中間件庫,優(yōu)化系統(tǒng) 設(shè)計,加快開發(fā)速度,提高開發(fā)質(zhì)量。
3.1 專用模塊功能分配
專用模塊功能分配,如表錯誤!未定義書簽。所示。
表錯誤 !未定義書簽。 專用模塊功能分配
專業(yè)模塊編 號
M1-1
M1-2
M2—1
模塊英文名
模塊詳細(xì)功能分配 模塊的接口標(biāo)準(zhǔn)
3.2 公用模塊功能分配
公用模塊功能分配
9、,如表錯誤!未定義書簽。所示:
表錯誤 !未定義書簽。 公用模塊功能分配
公用模塊編 號
G-1
G—2
G-3
模塊英文名
模塊詳細(xì)功能分配 模塊的接口標(biāo)準(zhǔn)
4.?dāng)?shù)據(jù)結(jié)構(gòu)設(shè)計
4.1 數(shù)據(jù)庫表名清單
數(shù)據(jù)庫表名清單,如表錯誤!未定義書簽。所示
表錯誤 !未定義書簽。 數(shù)據(jù)庫表名清單
序號
中文表名
英文表名
表功能說明
1
2
3
(完整 word 版)《概要設(shè)計》模板
4.2 數(shù)據(jù)庫表之間關(guān)系說明
可以用 E-R 圖表示,也可以用文字說明.
4.3 數(shù)據(jù)庫表的詳細(xì)清單
每個表的詳細(xì)清單內(nèi)
10、容包括:表名、字段中文名、字段英文名、字段的類型、寬度、精度、主鍵/外鍵、 空否、取值約束(默認(rèn)值、最大值、最小值)、索引否。同時要指出該表的索引:索引文件名、索引字段名、 索引特性(主鍵索引、惟一索引、聚集索引)。詳細(xì)清單可以用列表給出,如表 2 所示:
表 2 表名:×××
字段中文名
字段英文名
類型、寬度、精
取值約束 空否 默認(rèn)值 主鍵/外鍵 索引否
度
4.4 視圖設(shè)計
視圖設(shè)計與授權(quán)有關(guān),設(shè)計時參照需求文檔的用戶授權(quán)范圍。視圖設(shè)計中要給出視圖的中文名、英文名, 視圖中的中文列名、英文列名、類型、寬度、精度,每—列的具體算法,對應(yīng)的基本表名
11、.
4.5 其他數(shù)據(jù)結(jié)構(gòu)設(shè)計
此小節(jié)描述系統(tǒng)的其他數(shù)據(jù)結(jié)構(gòu)設(shè)計內(nèi)容。
5.接口設(shè)計
對應(yīng)每一個接口,都要詳細(xì)列出下列內(nèi)容:
(1)接口名稱
(2)接口內(nèi)容
(3)接口設(shè)施
(4)接口的數(shù)據(jù)結(jié)構(gòu)
(5)接口的傳輸速率(Mbps)
(6)接口帶寬
(7)接口協(xié)議
6.其他設(shè)計
本章描述前面沒有說明的設(shè)計。
7.設(shè)計檢查列表
(完整 word 版)《概要設(shè)計》模板
按照需求文檔的功能、性能和接口 3 個列表,設(shè)計出概要設(shè)計檢查列表,以檢查概要設(shè)計是否覆蓋需求 分析,沒有覆蓋就是不符合項,并將檢查結(jié)果列出。
7.1 功
12、能設(shè)計檢查列表
功能設(shè)計檢查列表,如表錯誤!未定義書簽。所示:
表錯誤 !未定義書簽。 功能設(shè)計檢查列表
號
功能名稱
使用部門
使用崗位
功能描述 輸入內(nèi)容 系統(tǒng)響應(yīng) 輸出內(nèi)容
是否覆蓋
7.2 性能設(shè)計檢查列表
性能設(shè)計檢查列表,如表錯誤!未定義書簽。所示。
表錯誤 !未定義書簽。 性能設(shè)計檢查列表
號
性能名稱
使用部門
使用崗位
性能描述 輸入內(nèi)容 系統(tǒng)響應(yīng) 輸出內(nèi)容
是否覆蓋
7.3 接口設(shè)計檢查列表
接口設(shè)計檢查列表,如表錯誤!未定義書簽。所示。
表錯誤 !未定義書簽。 接口設(shè)計檢查列表
編號
接口名稱
接口規(guī)范
接口標(biāo)準(zhǔn) 入口參數(shù) 出口參數(shù) 傳輸頻率
是否覆蓋