軟件具體設(shè)計(jì)匯報(bào)文檔模板1.引言 351.1編寫目標(biāo) 351.2項(xiàng)目風(fēng)險(xiǎn) 351.3文檔約定 351.4預(yù)期讀者和閱讀提議 351.5參考資料 362.支撐環(huán)境 362.1數(shù)據(jù)庫管理系統(tǒng) 362.2開發(fā)工具、中間件和數(shù)據(jù)庫接口 372.3硬件環(huán)境 372.4網(wǎng)絡(luò)環(huán)境 382.5多個(gè)支撐環(huán)境開發(fā)關(guān)鍵點(diǎn) 383.部件具體設(shè)計(jì) 384.詞匯表 395.部件表格式 406.界面表格式 40

引言引言是對(duì)這份軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)概覽，是為了幫助閱讀者了解這份文檔怎樣編寫，而且應(yīng)該怎樣閱讀、了解和解釋這份文檔。編寫目標(biāo)說明這份軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)是基于哪份軟件產(chǎn)品需求分析匯報(bào)、哪份軟件產(chǎn)品概要設(shè)計(jì)匯報(bào)和哪份軟件產(chǎn)品數(shù)據(jù)庫設(shè)計(jì)說明書(假如該軟件產(chǎn)品需要數(shù)據(jù)庫支持)編寫，開發(fā)這個(gè)軟件產(chǎn)品意義、作用、和最終要達(dá)成意圖。經(jīng)過這份軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)詳盡說明了該軟件產(chǎn)品編碼結(jié)構(gòu)，從而對(duì)該軟件產(chǎn)品物理組成進(jìn)行正確描述。假如這份軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)只和整個(gè)系統(tǒng)某一部分相關(guān)系，那么只定義軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)中說明那個(gè)部分或子系統(tǒng)。項(xiàng)目風(fēng)險(xiǎn)具體說明本軟件開發(fā)項(xiàng)目標(biāo)全部風(fēng)險(xiǎn)負(fù)擔(dān)者，和各自在本階段所需要負(fù)擔(dān)關(guān)鍵風(fēng)險(xiǎn)，首要風(fēng)險(xiǎn)負(fù)擔(dān)者包含：任務(wù)提出者；軟件開發(fā)者；產(chǎn)品使用者。文檔約定描述編寫文檔時(shí)所采取標(biāo)準(zhǔn)(假如有標(biāo)準(zhǔn)話)，或多種編寫約定。編寫約定應(yīng)該包含：部件編號(hào)方法；界面編號(hào)方法；命名規(guī)范：等等。預(yù)期讀者和閱讀提議列舉本軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)所針正確多種不一樣預(yù)期讀者，比如，可能讀者包含：開發(fā)人員；項(xiàng)目經(jīng)理；測試人員；文檔編寫人員；等等。描述文檔中，其它部分內(nèi)容及其組織結(jié)構(gòu)，而且針對(duì)每一類讀者提出最適合文檔閱讀提議。參考資料列舉編寫軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)時(shí)所用到參考文件及資料，可能包含：本項(xiàng)目標(biāo)協(xié)議書；上級(jí)機(jī)關(guān)相關(guān)本項(xiàng)目標(biāo)批文；本項(xiàng)目已經(jīng)同意計(jì)劃任務(wù)書；用戶界面風(fēng)格指導(dǎo)；開發(fā)本項(xiàng)目時(shí)所要用到標(biāo)難；系統(tǒng)規(guī)格需求說明；使用實(shí)例文檔；屬于本項(xiàng)目標(biāo)其它己發(fā)表文件；本軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)中所引用文件、資料；相關(guān)軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)；等等。為了方便讀者查閱，全部參考資料應(yīng)該按一定次序排列。假如可能，每份資料全部應(yīng)該給出：標(biāo)題名稱；作者或協(xié)議簽約者；文件編號(hào)或版本號(hào)；發(fā)表日期或簽約日期；出版單位或資料起源。支撐環(huán)境數(shù)據(jù)庫管理系統(tǒng)描述數(shù)據(jù)庫管理系統(tǒng)、和安裝配置情況，需要描述內(nèi)容可能包含：產(chǎn)品名稱和發(fā)行廠商這里產(chǎn)品名稱指是數(shù)據(jù)庫發(fā)行廠商公布產(chǎn)品時(shí)公布正式商品名稱，不應(yīng)該使用別名、簡稱、研發(fā)代號(hào)等非正式名稱，以免混淆；一樣道理，發(fā)行廠商名稱也應(yīng)該使用正式名稱。版本號(hào)數(shù)據(jù)庫管理系統(tǒng)正確版本號(hào)，必需按產(chǎn)品實(shí)際情況描述到最細(xì)節(jié)版本號(hào)。補(bǔ)丁包版本號(hào)描述實(shí)際上將要使用數(shù)據(jù)庫管理系統(tǒng)補(bǔ)丁包版本號(hào)，必需注意，在一些情況下該版本號(hào)不一定是最新版本號(hào)。語言或代碼集對(duì)于只支持一個(gè)語言或一個(gè)代碼集數(shù)據(jù)庫管理系統(tǒng)來說，該項(xiàng)描述不具意義。對(duì)于支持多個(gè)語言或多個(gè)代碼集數(shù)據(jù)庫管理系統(tǒng)來說，該項(xiàng)描述指是實(shí)際使用語言或代碼集。安裝位置描述數(shù)據(jù)庫管理系統(tǒng)實(shí)際安裝位置，應(yīng)該分別對(duì)管理系統(tǒng)安缺位置和數(shù)據(jù)存放位置進(jìn)行描述，應(yīng)該指明服務(wù)器名和安裝卷號(hào)(盤號(hào))。對(duì)于分布式數(shù)據(jù)庫，必需分別描述每一個(gè)數(shù)據(jù)庫管理系統(tǒng)。配置參數(shù)描述數(shù)據(jù)庫管理系統(tǒng)在實(shí)際安裝時(shí)應(yīng)該配置各個(gè)參數(shù)，對(duì)于分布式數(shù)據(jù)庫，必須分別描述每一個(gè)數(shù)據(jù)庫管理系統(tǒng)配置參數(shù)。等等同時(shí)參考《南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范》。開發(fā)工具、中間件和數(shù)據(jù)庫接口描述所選擇工具軟件和中間件名稱、版本號(hào)，和開發(fā)工具和數(shù)據(jù)庫或中間件接口情況。假如使用了多個(gè)開發(fā)工具、輔助開發(fā)工具、第三方軟件部件、多個(gè)中間件、多個(gè)接口、等答應(yīng)該逐項(xiàng)分別描述，而且說明每一項(xiàng)適用范圍。需要描述內(nèi)容可能包含：產(chǎn)品名稱和發(fā)行廠商同2.1中產(chǎn)品名稱和發(fā)行廠商。版本號(hào)同2.1中版本號(hào)。補(bǔ)丁包版本號(hào)同2.1中補(bǔ)丁包版本號(hào)。語言或代碼集同2.1中語言或代碼集。數(shù)據(jù)庫接口名稱描述數(shù)據(jù)庫接口名稱，假如使用別名時(shí)，應(yīng)同時(shí)描述使用別名。數(shù)據(jù)庫接口方法描述和數(shù)據(jù)庫接口方法，并說明該接口方法特點(diǎn)；假如需要，還應(yīng)該說明使用時(shí)注意事項(xiàng)。數(shù)據(jù)庫接口設(shè)置描述多種接口設(shè)置，包含：協(xié)議、端口號(hào)等等。同時(shí)參考《南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范》。硬件環(huán)境描述所選擇硬件環(huán)境，多種機(jī)型，比如：服務(wù)器、工作站，應(yīng)該分別描述。需要描述內(nèi)容可能包含：機(jī)型；主頻；內(nèi)存容量；磁盤容量；特殊部件；操作系統(tǒng)；使用位置；等等。網(wǎng)絡(luò)環(huán)境描述可能影響應(yīng)用軟件訪問數(shù)據(jù)庫多種網(wǎng)絡(luò)環(huán)境，假如存在加密傳輸、VPN鏈路等情況，也必需描述。對(duì)于結(jié)構(gòu)復(fù)雜網(wǎng)絡(luò)，還應(yīng)該提供網(wǎng)絡(luò)拓?fù)鋱D和數(shù)據(jù)流向示意圖。需要描述內(nèi)容可能包含：網(wǎng)絡(luò)結(jié)構(gòu)；網(wǎng)絡(luò)操作系統(tǒng)；網(wǎng)絡(luò)帶寬；路由組織；加密傳輸方法；VPN鏈路連接方法；等等。多個(gè)支撐環(huán)境開發(fā)關(guān)鍵點(diǎn)當(dāng)軟件產(chǎn)品未來可能碰到多個(gè)運(yùn)行環(huán)境時(shí)，應(yīng)該分別根據(jù)3.1節(jié)至3.4節(jié)內(nèi)容列表描述。假如軟件產(chǎn)品各個(gè)子系統(tǒng)運(yùn)行環(huán)境不完全一樣時(shí)，應(yīng)該分子系統(tǒng)根據(jù)3.1節(jié)至3.4節(jié)內(nèi)容列表描述。碰到上述情況時(shí)，不僅需要具體描述多種軟件開發(fā)、調(diào)試、測試環(huán)境，為了確實(shí)確保軟件產(chǎn)品未來能夠在多種可能運(yùn)行環(huán)境中正常運(yùn)行，還需要對(duì)軟件產(chǎn)品進(jìn)行嚴(yán)格配置管理。部件具體設(shè)計(jì)這里所提及軟件部件，系指能夠完成特定功效、相對(duì)獨(dú)立部分代碼集合，它們能夠是插件、組件、控件、函數(shù)、過程、子程序、動(dòng)態(tài)連接庫、等等。具體呈何種形態(tài)，取決于實(shí)際采取開發(fā)工具和將要實(shí)現(xiàn)軟件結(jié)構(gòu)。根據(jù)適宜次序，逐一描述軟件部件具體情況。描述次序能夠是按層次橫向進(jìn)行描述，也能夠是按模塊縱向進(jìn)行描述，總而言之描述方法必需有利于讀者了解軟件結(jié)構(gòu)。每個(gè)部件采取一張軟件部件表進(jìn)行描述，軟件部件表格式見附表一，其中；部件編號(hào)軟件部件統(tǒng)一次序編號(hào)；對(duì)于實(shí)施配置管理軟件開發(fā)項(xiàng)目來說，該編號(hào)必需和該部件在配置管理中編號(hào)相同。部件名稱軟件部件正式英文名稱，該名稱是程序中使用實(shí)際名稱，必需符合國家相關(guān)軟件命名標(biāo)準(zhǔn)。所屬子系統(tǒng)指該部件所屬子系統(tǒng)；對(duì)于不分為多個(gè)子系統(tǒng)軟件來說，無須填寫該欄。部件調(diào)用者指調(diào)用該部件部件(或界面參數(shù))編號(hào)和名稱。部件被調(diào)用者指被該部件所調(diào)用部件編號(hào)和名稱。部件入口參數(shù)指該部件入口數(shù)據(jù)類名稱或數(shù)據(jù)名稱，和對(duì)這些數(shù)據(jù)描述；假如部件沒有入口參數(shù)，該欄為空。部件出口參數(shù)指該部件出口數(shù)據(jù)類名稱或數(shù)據(jù)名稱，和對(duì)這些數(shù)據(jù)描述；假如部件沒有出口參數(shù)，該欄為空。算法指該部件算法形式表示，假如很簡單、或不存在，也能夠?yàn)榭?。步驟描述指該部件處理步驟具體表示或描述。部件表示形式指該部件完成開發(fā)后最終表示形式，具體形式取決于開發(fā)工具和軟件結(jié)構(gòu)，表示形式可能是：插件、組件、控件，函數(shù)、過程、子程序，存放過程，動(dòng)態(tài)連接庫，等等。運(yùn)行環(huán)境描述該部件所適合運(yùn)行環(huán)境，即說明該部件是針對(duì)何種運(yùn)行環(huán)境所開發(fā)；能夠直接描述運(yùn)行環(huán)境，也能夠描述運(yùn)行環(huán)境編號(hào)；對(duì)于實(shí)施配置管理軟件開發(fā)項(xiàng)目來說，該描述必需和該部件在配置管理中描相同。性能要求指開發(fā)該部件時(shí)必需滿足專門要求，這些要求能夠是：精度靈活性響應(yīng)時(shí)間可重用性等等。提出要求通常不宜超出3項(xiàng)，以排列前后次序表示優(yōu)先級(jí)。詞匯表列出本文件中用到專業(yè)術(shù)語定義，和相關(guān)縮寫定義(如有可能，列出相關(guān)外文原詞)。為了便于非軟件專業(yè)或非計(jì)算機(jī)專業(yè)人士也能夠在一定范圍內(nèi)，讀懂軟件系統(tǒng)具體設(shè)計(jì)匯報(bào)，要求盡可能使用非軟件專業(yè)或非計(jì)算機(jī)專業(yè)術(shù)語進(jìn)行描述。所以這里所指專業(yè)術(shù)語，是指業(yè)務(wù)層面上專業(yè)術(shù)語，而不是軟件專業(yè)或計(jì)算機(jī)專業(yè)術(shù)語。不過，對(duì)于無法回避軟件專業(yè)或計(jì)算機(jī)專業(yè)術(shù)語，也應(yīng)該列入詞匯表，而且加以正確定義。部件表格式部件編號(hào)部件名稱所屬子系統(tǒng)