《軟件工程與項(xiàng)目管理》5-軟件設(shè)計(jì)說(shuō)明書(shū)

《軟件工程與項(xiàng)目管理》實(shí)驗(yàn)文檔（5）軟件設(shè)計(jì)說(shuō)明書(shū)（V1.0）項(xiàng)目名稱：項(xiàng)目組：責(zé)任人：執(zhí)筆人：參加人：審核人：編制日期：

軟件設(shè)計(jì)說(shuō)明書(shū)編寫(xiě)指南1引言1.1編寫(xiě)目的本文檔的目的旨在推動(dòng)軟件工程的規(guī)范化，使設(shè)計(jì)人員遵循統(tǒng)一的設(shè)計(jì)書(shū)寫(xiě)規(guī)范，節(jié)省制作文檔的時(shí)間，降低系統(tǒng)實(shí)現(xiàn)的風(fēng)險(xiǎn)，做到系統(tǒng)設(shè)計(jì)資料的規(guī)范性與全面性，以利于系統(tǒng)的實(shí)現(xiàn)、測(cè)試、維護(hù)、版本升級(jí)等。1.2命名規(guī)范變量對(duì)象命名規(guī)則：申明全局變量、局部變量對(duì)象的命名規(guī)則。數(shù)據(jù)庫(kù)對(duì)象命名規(guī)則：申明數(shù)據(jù)庫(kù)表名、字段名、索引名、視圖名等對(duì)象的命名規(guī)則。1.3術(shù)語(yǔ)定義列出本文檔中用到的專門(mén)術(shù)語(yǔ)的定義和外文首字母縮寫(xiě)詞的原詞組。1.4參考資料列出有關(guān)的參考文件，如：a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同，上級(jí)機(jī)關(guān)的批文；b.屬于本項(xiàng)目的其他已發(fā)表的文件；c.本文檔中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。1.5相關(guān)文檔1.6版本更新記錄版本更新記錄格式，如表1所示。表1版本更新記錄版本號(hào)創(chuàng)建者創(chuàng)建日期維護(hù)者維護(hù)日期維護(hù)紀(jì)要V1.02總體設(shè)計(jì)2.1總體結(jié)構(gòu)設(shè)計(jì)用一覽表及框圖的形式說(shuō)明本系統(tǒng)的系統(tǒng)元素（各層模塊、子程序、公用程序等）的劃分，扼要說(shuō)明每個(gè)系統(tǒng)元素的標(biāo)識(shí)符和功能，分層次地給出各元素之間的控制與被控制關(guān)系。2.2硬件運(yùn)行環(huán)境設(shè)計(jì)硬件平臺(tái)：服務(wù)器的最低配置要求；工作站的最低配置要求；外設(shè)的要求。2.3軟件運(yùn)行環(huán)境設(shè)計(jì)軟件平臺(tái)：服務(wù)器操作系統(tǒng)；數(shù)據(jù)庫(kù)管理系統(tǒng)；中間件；客戶機(jī)的操作系統(tǒng)；客戶機(jī)的平臺(tái)軟件。2.4子系統(tǒng)清單子系統(tǒng)清單如表2所示。表2子系統(tǒng)清單子系統(tǒng)編號(hào)子系統(tǒng)名稱子系統(tǒng)功能簡(jiǎn)述子系統(tǒng)之間的關(guān)系2.5功能模塊清單功能模塊清單如表3所示。表3功能模塊清單模塊編號(hào)模塊名稱模塊功能簡(jiǎn)述模塊的接口簡(jiǎn)述3模塊功能分配具有功能獨(dú)立、能被調(diào)用的信息單元叫做模塊。模塊是結(jié)構(gòu)化設(shè)計(jì)中的概念，部件是面向?qū)ο笤O(shè)計(jì)中的概念。模塊功能分配的目的，就是為了將具有相同功能的模塊合并，從中提取公用模塊，形成公用部件，按照構(gòu)件或中間件的方式加以實(shí)現(xiàn)，作為本系統(tǒng)的公用資源，甚至作為公司級(jí)組織的公用資源，從而充實(shí)公司級(jí)的構(gòu)件庫(kù)或中間件庫(kù)，優(yōu)化系統(tǒng)設(shè)計(jì)，加快開(kāi)發(fā)速度，提高開(kāi)發(fā)質(zhì)量。3.1公用模塊功能分配公用模塊功能分配如表4所示。表4公用模塊功能分配公用模塊編號(hào)模塊名稱模塊詳細(xì)功能分配模塊的接口標(biāo)準(zhǔn)3.2專用模塊功能分配專用模塊功能分配如表5所示。表5專用模塊功能分配專用模塊編號(hào)模塊名稱模塊詳細(xì)功能分配模塊的接口標(biāo)準(zhǔn)4數(shù)據(jù)庫(kù)設(shè)計(jì)4.1數(shù)據(jù)庫(kù)表名列表數(shù)據(jù)庫(kù)表名列表格式如表6所示。表6數(shù)據(jù)庫(kù)表名列表序號(hào)中文表名英文表名表功能說(shuō)明124.2數(shù)據(jù)庫(kù)表之間關(guān)系說(shuō)明可以用E-R圖表示，也可以用文字說(shuō)明。4.3數(shù)據(jù)庫(kù)表的詳細(xì)清單每個(gè)表的詳細(xì)清單內(nèi)容包括表名，中文字段名，英文字段名，數(shù)據(jù)類型、寬度、精度，主鍵/外鍵，是否允許為空，取值約束（默認(rèn)值、最大值、最小值），索引否。同時(shí)要指出該表的索引：索引文件名、索引字段名、索引特性（主鍵索引、唯一索引、聚集索引）。用戶可以根據(jù)實(shí)際情況進(jìn)行裁減。詳細(xì)清單可以用列表給出，如表7所示。表7表名：XXXX序號(hào)英文字段名中文字段名數(shù)據(jù)類型、寬度、精度取值約束是否允許為空主鍵/外鍵索引否4.4視圖設(shè)計(jì)視圖設(shè)計(jì)中要給出視圖的中文名、英文名，視圖中的中文列名、英文列名、類型、寬度、精度，每一列的具體算法，對(duì)應(yīng)的基本表名。5其他設(shè)計(jì)本章描述前面沒(méi)有說(shuō)明的設(shè)計(jì)，如接口設(shè)計(jì)、每個(gè)功能模塊的詳細(xì)設(shè)計(jì)、存儲(chǔ)過(guò)程設(shè)計(jì)、角色授權(quán)設(shè)計(jì)等。6系統(tǒng)出錯(cuò)處理設(shè)計(jì)6.1出錯(cuò)信息說(shuō)明每種可能的錯(cuò)誤或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息的形式、含義及處理方法。6.2故障預(yù)防與補(bǔ)救說(shuō)明故障出現(xiàn)前的預(yù)防措施以及出現(xiàn)后可能采取的變通措施。6.3系統(tǒng)維護(hù)設(shè)計(jì)說(shuō)明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中做出的安排，包括在程序中專門(mén)安排用于系統(tǒng)的檢