軟件詳細(xì)設(shè)計報告文檔軟件詳細(xì)設(shè)計報告文檔模板引言是對這份軟件系統(tǒng)詳細(xì)設(shè)計報告的概覽，是為了幫助閱讀者了解這份文檔如何編寫的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。1.1編寫目的說明這份軟件系統(tǒng)詳細(xì)設(shè)計報告是基于哪份軟件產(chǎn)品需求分析報告、哪份軟件產(chǎn)品概要設(shè)計報告和哪份軟件產(chǎn)品數(shù)據(jù)庫設(shè)計說明書(如果該軟件產(chǎn)品需要數(shù)據(jù)庫支持)編寫的，開發(fā)這個軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過這份軟件系統(tǒng)詳細(xì)設(shè)計報告詳盡說明了該軟件產(chǎn)品的編碼結(jié)構(gòu)，從而對該軟件產(chǎn)品的物理組成進(jìn)行準(zhǔn)確的描述。如果這份軟件系統(tǒng)詳細(xì)設(shè)計報告只與整個系統(tǒng)的某一部分有關(guān)系，那么只定義軟件系統(tǒng)詳細(xì)設(shè)計報告中說明的那個部分或子系統(tǒng)。1.2項目風(fēng)險具體說明本軟件開發(fā)項目的全部風(fēng)險承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險，首要風(fēng)險承擔(dān)者包括：●任務(wù)提出者；●軟件開發(fā)者；●產(chǎn)品使用者。1.3文檔約定描述編寫文檔時所采用的標(biāo)準(zhǔn)(如果有標(biāo)準(zhǔn)的話)，或者各種編寫約定。編寫約定●部件編號方式；●界面編號方式；●命名規(guī)范：●等等。1.4預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)詳細(xì)設(shè)計報告所針對的各種不同的預(yù)期讀者，例如，可能的讀者●開發(fā)人員；●項目經(jīng)理；●測試人員；●文檔編寫人員；●等等。描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對每一類讀者提出最適合的1.5參考資料列舉編寫軟件系統(tǒng)詳細(xì)設(shè)計報告時所用到的參考文獻(xiàn)及資料，可能包括：●本項目的合同書；●上級機(jī)關(guān)有關(guān)本項目的批文；●本項目已經(jīng)批準(zhǔn)的計劃任務(wù)書；●用戶界面風(fēng)格指導(dǎo)；●開發(fā)本項目時所要用到的標(biāo)難；●系統(tǒng)規(guī)格需求說明；●使用實例文檔；●屬于本項目的其它己發(fā)表文件；●本軟件系統(tǒng)詳細(xì)設(shè)計報告中所引用的文件、資料；●相關(guān)軟件系統(tǒng)詳細(xì)設(shè)計報告；●等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順序排列。如果可能，每份資料都●標(biāo)題名稱；●作者或者合同簽約者；●文件編號或者版本號；●發(fā)表日期或者簽約日期；●出版單位或者資料來源。2.支撐環(huán)境2.1數(shù)據(jù)庫管理系統(tǒng)描述數(shù)據(jù)庫管理系統(tǒng)、以及安裝配置情況，需要描述的內(nèi)容可能包括：●產(chǎn)品名稱以及發(fā)行廠商這里的產(chǎn)品名稱指的是數(shù)據(jù)庫發(fā)行廠商發(fā)布產(chǎn)品時公布的正式商品名稱，不應(yīng)該使用別名、簡稱、研發(fā)代號等非正式名稱，以免混淆；同樣的道理，發(fā)行廠商的名稱也應(yīng)該使用正式名稱?！癜姹咎枖?shù)據(jù)庫管理系統(tǒng)的準(zhǔn)確版本號，必須按產(chǎn)品的實際情況描述到最細(xì)節(jié)●補丁包版本號描述實際上將要使用的數(shù)據(jù)庫管理系統(tǒng)補丁包的版本號，必須注意，在某些情況下該版本號不一定是最新的版本號?！裾Z言或代碼集對于只支持一種語言或者一個代碼集的數(shù)據(jù)庫管理系統(tǒng)來說，該項描述不具意義。對于支持多種語言或者多個代碼集的數(shù)據(jù)庫管理系統(tǒng)來說，該項描述指的是實際使用的語言或者代碼集?！癜惭b位置描述數(shù)據(jù)庫管理系統(tǒng)的實際安裝位置，應(yīng)該分別對管理系統(tǒng)安缺位置和數(shù)據(jù)存放位置進(jìn)行描述，應(yīng)該指明服務(wù)器名和安裝卷號(盤號)。對于分布式數(shù)據(jù)庫，必須分別描述每一個數(shù)據(jù)庫管理系統(tǒng)?！衽渲脜?shù)描述數(shù)據(jù)庫管理系統(tǒng)在實際安裝時應(yīng)該配置的各個參數(shù)，對于分布式數(shù)據(jù)庫，必須分別描述每一個數(shù)據(jù)庫管理系統(tǒng)的配置參數(shù)?！竦鹊韧瑫r參照《南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范》。2.2開發(fā)工具、中間件以及數(shù)據(jù)庫接口描述所選用的工具軟件和中間件的名稱、版本號，以及開發(fā)工具與數(shù)據(jù)庫或者中間件接口的情況。如果使用了多種開發(fā)工具、輔助開發(fā)工具、第三方軟件部件、多種中間件、多種接口、等答應(yīng)該逐項分別描述，并且說明每一項的適用范圍。包括：●產(chǎn)品名稱以及發(fā)行廠商同中產(chǎn)品名稱以及發(fā)行廠商。●版本號●補丁包版本號●語言或代碼集●數(shù)據(jù)庫接口名稱描述數(shù)據(jù)庫接口的名稱，如果使用別名時，應(yīng)同時描述使用的別名?！駭?shù)據(jù)庫接口方式描述與數(shù)據(jù)庫接口的方式，并說明該接口方式的特點；如果需要，還應(yīng)該說明使時的注意事項?！駭?shù)據(jù)庫接口設(shè)置描述各種接口設(shè)置，包括：協(xié)議、端口號等等。同時參照《南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范》。2.3硬件環(huán)境描述所選用的硬件環(huán)境，各種機(jī)型，例如：服務(wù)器、工作站，應(yīng)該分別描述。需容可能包括：；頻；●內(nèi)存容量；●磁盤容量；●特殊部件；●操作系統(tǒng)；●使用位置；●等等。2.4網(wǎng)絡(luò)環(huán)境描述可能影響應(yīng)用軟件訪問數(shù)據(jù)庫的各種網(wǎng)絡(luò)環(huán)境，如果存在加密傳輸、VPN鏈路等情況，也必須描述。對于結(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ò)帶寬；●路由組織；●加密傳輸方式；●等等。2.5多種支撐環(huán)境開發(fā)要點當(dāng)軟件產(chǎn)品將來可能遇到的多種運行環(huán)境時，應(yīng)該分別按照節(jié)至節(jié)的內(nèi)容列表描述。如果軟件產(chǎn)品各個子系統(tǒng)的運行環(huán)境不完全一樣時，應(yīng)該分子系統(tǒng)按照節(jié)至節(jié)的內(nèi)容列表描述。遇到上述情況時，不僅需要詳細(xì)描述各種軟件開發(fā)、調(diào)試、測試的環(huán)境，為了確實保證軟件產(chǎn)品將來能夠在各種可能的運行環(huán)境中正常運行，還需要對軟件產(chǎn)品進(jìn)行嚴(yán)格的配置管理。3.部件詳細(xì)設(shè)計這里所提及的軟件部件，系指能夠完成特定功能、相對獨立的一些代碼集合，它們可以是插件、組件、控件、函數(shù)、過程、子程序、動態(tài)連接庫、等等。具體呈何種形態(tài)，取決于實際采用的開發(fā)工具和將要實現(xiàn)的軟件結(jié)構(gòu)。按照合適的順序，逐個描述軟件部件的詳細(xì)情況。描述的順序可以是按層次橫向進(jìn)行描述，也可以是按模塊縱向進(jìn)行描述，總之描述的方式必須有利于讀者理解每個部件采用一張軟件部件表進(jìn)行描述，軟件部件表的格式見附表一，其中；●部件編號軟件部件的統(tǒng)一順序編號；對于實行配置管理的軟件開發(fā)項目來說，該編號必須與該部件在配置管理中的編號相同?！癫考Q軟件部件的正式英文名稱，該名稱是程序中使用的實際名稱，必須符合國家相關(guān)軟件命名標(biāo)準(zhǔn)?！袼鶎僮酉到y(tǒng)指該部件所屬的子系統(tǒng)；對于不分為多個子系統(tǒng)的軟件來說，不必填寫該欄?！癫考{(diào)用者指調(diào)用該部件的部件(或界面參數(shù))的編號和名稱。●部件被調(diào)用者指被該部件所調(diào)用的部件的編號和名稱?！癫考肟趨?shù)指該部件入口數(shù)據(jù)類名稱或者數(shù)據(jù)名稱，以及對這些數(shù)據(jù)的描述；如果部件沒有入口參數(shù)，該欄為空。●部件出口參數(shù)指該部件出口數(shù)據(jù)類名稱或者數(shù)據(jù)名稱，以及對這些數(shù)據(jù)的描述；如果部件沒有出口參數(shù)，該欄為空?！袼惴ㄖ冈摬考乃惴ㄐ问奖硎荆绻芎唵?、或者不存在，也可以為空。●流程描述指該部件的處理流程的詳細(xì)表示或描述。●部件表示形式指該部件完成開發(fā)后的最終表示形式，具體形式取決于開發(fā)工具和軟件結(jié)構(gòu)，表●運行環(huán)境描述該部件所適合的運行環(huán)境，即說明該部件是針對何種運行環(huán)境所可以直接描述運行環(huán)境，也可以描述運行環(huán)境的編號；對于實行配置管理的軟件開發(fā)項目來說，該描述必須與該部件在配置管理中的描●性能要求指開發(fā)該部件時必須滿足的專門要求，這些要求可以是：精度靈活性響應(yīng)時間可重用性提出的要求一般不宜超過3項，以排列的先后順序表示優(yōu)先級。4.詞匯表列出本文件中用到的專業(yè)術(shù)語的定義，以及有關(guān)縮寫的定義(如有可能，列出相關(guān)的外文原詞)。為了便于非軟件專業(yè)或者非計算機(jī)專業(yè)人士也能夠在一定的范圍內(nèi)，讀懂軟件系統(tǒng)詳細(xì)設(shè)計報告，要求盡可能使用非軟件專業(yè)或者非計算機(jī)專業(yè)的術(shù)語進(jìn)行描述。所以這里所指的專業(yè)術(shù)語，是指業(yè)務(wù)層面上的專業(yè)術(shù)語，而不是軟件專業(yè)或者計算機(jī)專業(yè)的術(shù)語。但是，對于無法回避的軟件專業(yè)或者計算機(jī)專業(yè)術(shù)語，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。5.部件表格式部部件編號所屬子系統(tǒng)部件調(diào)用者部件被調(diào)用者部件入口參數(shù)部件入口參數(shù)表示性能性能要求部件名稱運行環(huán)境說明：如果軟件不見使用一張表