軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板公司對(duì)外紅頭文件模板

1、第 PAGE16 頁(yè) 共 NUMPAGES16 頁(yè)軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板，公司對(duì)外紅頭文件模板軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板TOC o “1-3” h z u 1.引言 351.1編寫(xiě)目的 351.2項(xiàng)目風(fēng)險(xiǎn) 351.3文檔約定 351.4預(yù)期讀者和閱讀建議 351.5參考資料 362.支撐環(huán)境 362.1數(shù)據(jù)庫(kù)管理系統(tǒng) 362.2開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口 372.3硬件環(huán)境 372.4網(wǎng)絡(luò)環(huán)境 382.5多種支撐環(huán)境開(kāi)發(fā)要點(diǎn) 383.部件詳細(xì)設(shè)計(jì) 384.詞匯表 395.部件表格式 406.界面表格式 40引言引言是對(duì)這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔如何編寫(xiě)的，

2、并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求分析p 報(bào)告、哪份軟件產(chǎn)品概要設(shè)計(jì)報(bào)告和哪份軟件產(chǎn)品數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)(如果該軟件產(chǎn)品需要數(shù)據(jù)庫(kù)支持)編寫(xiě)的，開(kāi)發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過(guò)這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告詳盡說(shuō)明了該軟件產(chǎn)品的編碼結(jié)構(gòu)，從而對(duì)該軟件產(chǎn)品的物理組成進(jìn)行準(zhǔn)確的描述。如果這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告中說(shuō)明的那個(gè)部分或子系統(tǒng)。項(xiàng)目風(fēng)險(xiǎn)具體說(shuō)明本軟件開(kāi)發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括：任務(wù)提出者；軟件開(kāi)發(fā)者；

3、產(chǎn)品使用者。文檔約定描述編寫(xiě)文檔時(shí)所采用的標(biāo)準(zhǔn)(如果有標(biāo)準(zhǔn)的話)，或者各種編寫(xiě)約定。編寫(xiě)約定應(yīng)該包括：部件編號(hào)方式；界面編號(hào)方式；命名規(guī)范：等等。預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告所針對(duì)的各種不同的預(yù)期讀者，例如，可能的讀者包括：開(kāi)發(fā)人員；項(xiàng)目經(jīng)理；測(cè)試人員；文檔編寫(xiě)人員；等等。描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類(lèi)讀者提出最適合的文檔閱讀建議。參考資料列舉編寫(xiě)軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告時(shí)所用到的【參考文獻(xiàn)】：p 及資料，可能包括：本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；用戶(hù)界面風(fēng)格指導(dǎo)；開(kāi)發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)難；系統(tǒng)規(guī)格需求說(shuō)明；使用實(shí)例文

4、檔；屬于本項(xiàng)目的其它己發(fā)表文件；本軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告中所引用的文件、資料；相關(guān)軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告；等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順序排列。如果可能，每份資料都應(yīng)該給出：標(biāo)題名稱(chēng)；作者或者合同簽約者；文件編號(hào)或者版本號(hào)；發(fā)表日期或者簽約日期；出版單位或者資料來(lái)。支撐環(huán)境數(shù)據(jù)庫(kù)管理系統(tǒng)描述數(shù)據(jù)庫(kù)管理系統(tǒng)、以及安裝配置情況，需要描述的內(nèi)容可能包括：產(chǎn)品名稱(chēng)以及發(fā)行廠商這里的產(chǎn)品名稱(chēng)指的是數(shù)據(jù)庫(kù)發(fā)行廠商發(fā)布產(chǎn)品時(shí)公布的正式商品名稱(chēng)，不應(yīng)該使用別名、簡(jiǎn)稱(chēng)、研發(fā)代號(hào)等非正式名稱(chēng)，以免混淆；同樣的道理，發(fā)行廠商的名稱(chēng)也應(yīng)該使用正式名稱(chēng)。版本號(hào)數(shù)據(jù)庫(kù)管理系統(tǒng)的準(zhǔn)確版本號(hào)，必須按產(chǎn)品的實(shí)際情

5、況描述到最細(xì)節(jié)的版本號(hào)。補(bǔ)丁包版本號(hào)描述實(shí)際上將要使用的數(shù)據(jù)庫(kù)管理系統(tǒng)補(bǔ)丁包的版本號(hào)，必須注意，在某些情況下該版本號(hào)不一定是最新的版本號(hào)。語(yǔ)言或代碼集對(duì)于只支持一種語(yǔ)言或者一個(gè)代碼集的數(shù)據(jù)庫(kù)管理系統(tǒng)來(lái)說(shuō)，該項(xiàng)描述不具意義。對(duì)于支持多種語(yǔ)言或者多個(gè)代碼集的數(shù)據(jù)庫(kù)管理系統(tǒng)來(lái)說(shuō)，該項(xiàng)描述指的是實(shí)際使用的語(yǔ)言或者代碼集。安裝位置描述數(shù)據(jù)庫(kù)管理系統(tǒng)的實(shí)際安裝位置，應(yīng)該分別對(duì)管理系統(tǒng)安缺位置和數(shù)據(jù)存放位置進(jìn)行描述，應(yīng)該指明服務(wù)器名和安裝卷號(hào)(盤(pán)號(hào))。對(duì)于分布式數(shù)據(jù)庫(kù)，必須分別描述每一個(gè)數(shù)據(jù)庫(kù)管理系統(tǒng)。配置參數(shù)描述數(shù)據(jù)庫(kù)管理系統(tǒng)在實(shí)際安裝時(shí)應(yīng)該配置的各個(gè)參數(shù)，對(duì)于分布式數(shù)據(jù)庫(kù)，必須分別描述每一個(gè)數(shù)據(jù)庫(kù)管理系

6、統(tǒng)的配置參數(shù)。等等同時(shí)參照南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范。開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口描述所選用的工具軟件和中間件的名稱(chēng)、版本號(hào)，以及開(kāi)發(fā)工具與數(shù)據(jù)庫(kù)或者中間件接口的情況。如果使用了多種開(kāi)發(fā)工具、輔助開(kāi)發(fā)工具、第三方軟件部件、多種中間件、多種接口、等答應(yīng)該逐項(xiàng)分別描述，并且說(shuō)明每一項(xiàng)的適用范圍。需要描述的內(nèi)容可能包括：產(chǎn)品名稱(chēng)以及發(fā)行廠商同2.1中產(chǎn)品名稱(chēng)以及發(fā)行廠商。版本號(hào)同2.1中版本號(hào)。補(bǔ)丁包版本號(hào)同2.1中補(bǔ)丁包版本號(hào)。語(yǔ)言或代碼集同2.1中語(yǔ)言或代碼集。數(shù)據(jù)庫(kù)接口名稱(chēng)描述數(shù)據(jù)庫(kù)接口的名稱(chēng)，如果使用別名時(shí)，應(yīng)同時(shí)描述使用的別名。數(shù)據(jù)庫(kù)接口方式描述與數(shù)據(jù)庫(kù)接口的方式，并說(shuō)明該接口方式

7、的特點(diǎn)；如果需要，還應(yīng)該說(shuō)明使用時(shí)的注意事項(xiàng)。數(shù)據(jù)庫(kù)接口設(shè)置描述各種接口設(shè)置，包括：協(xié)議、端口號(hào)等等。同時(shí)參照南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范。硬件環(huán)境描述所選用的硬件環(huán)境，各種機(jī)型，例如：服務(wù)器、工作站，應(yīng)該分別描述。需要描述的內(nèi)容可能包括：機(jī)型；主頻；內(nèi)存容量；磁盤(pán)容量；特殊部件；操作系統(tǒng)；使用位置；等等。網(wǎng)絡(luò)環(huán)境描述可能影響應(yīng)用軟件訪問(wèn)數(shù)據(jù)庫(kù)的各種網(wǎng)絡(luò)環(huán)境，如果存在加密傳輸、鏈路等情況，也必須描述。對(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ò)帶寬；路由組織；加密傳輸方式；鏈路連接方式；等等。多種支撐環(huán)境開(kāi)發(fā)要點(diǎn)當(dāng)軟件產(chǎn)品將

8、來(lái)可能遇到的多種運(yùn)行環(huán)境時(shí)，應(yīng)該分別按照3.1節(jié)至3.4節(jié)的內(nèi)容列表描述。如果軟件產(chǎn)品各個(gè)子系統(tǒng)的運(yùn)行環(huán)境不完全一樣時(shí)，應(yīng)該分子系統(tǒng)按照3.1節(jié)至3.4節(jié)的內(nèi)容列表描述。遇到上述情況時(shí)，不僅需要詳細(xì)描述各種軟件開(kāi)發(fā)、調(diào)試、測(cè)試的環(huán)境，為了確實(shí)保證軟件產(chǎn)品將來(lái)能夠在各種可能的運(yùn)行環(huán)境中正常運(yùn)行，還需要對(duì)軟件產(chǎn)品進(jìn)行嚴(yán)格的配置管理。部件詳細(xì)設(shè)計(jì)這里所提及的軟件部件，系指能夠完成特定功能、相對(duì)獨(dú)立的一些代碼集合，它們可以是插件、組件、控件、函數(shù)、過(guò)程、子程序、動(dòng)態(tài)連接庫(kù)、等等。具體呈何種形態(tài)，取決于實(shí)際采用的開(kāi)發(fā)工具和將要實(shí)現(xiàn)的軟件結(jié)構(gòu)。按照合適的順序，逐個(gè)描述軟件部件的詳細(xì)情況。描述的順序可以是按

9、層次橫向進(jìn)行描述，也可以是按模塊縱向進(jìn)行描述，總之描述的方式必須有利于讀者理解軟件結(jié)構(gòu)。每個(gè)部件采用一張軟件部件表進(jìn)行描述，軟件部件表的格式見(jiàn)附表一，其中；部件編號(hào)軟件部件的統(tǒng)一順序編號(hào)；對(duì)于實(shí)行配置管理的軟件開(kāi)發(fā)項(xiàng)目來(lái)說(shuō)，該編號(hào)必須與該部件在配置管理中的編號(hào)相同。部件名稱(chēng)軟件部件的正式英文名稱(chēng)，該名稱(chēng)是程序中使用的實(shí)際名稱(chēng)，必須符合國(guó)家相關(guān)軟件命名標(biāo)準(zhǔn)。所屬子系統(tǒng)指該部件所屬的子系統(tǒng)；對(duì)于不分為多個(gè)子系統(tǒng)的軟件來(lái)說(shuō)，不必填寫(xiě)該欄。部件調(diào)用者指調(diào)用該部件的部件(或界面參數(shù))的編號(hào)和名稱(chēng)。部件被調(diào)用者指被該部件所調(diào)用的部件的編號(hào)和名稱(chēng)。部件入口參數(shù)指該部件入口數(shù)據(jù)類(lèi)名稱(chēng)或者數(shù)據(jù)名稱(chēng)，以及對(duì)這些數(shù)

10、據(jù)的描述；如果部件沒(méi)有入口參數(shù)，該欄為空。部件出口參數(shù)指該部件出口數(shù)據(jù)類(lèi)名稱(chēng)或者數(shù)據(jù)名稱(chēng)，以及對(duì)這些數(shù)據(jù)的描述；如果部件沒(méi)有出口參數(shù)，該欄為空。算法指該部件的算法形式表示，如果很簡(jiǎn)單、或者不存在，也可以為空。流程描述指該部件的處理流程的詳細(xì)表示或描述。部件表示形式指該部件完成開(kāi)發(fā)后的最終表示形式，具體形式取決于開(kāi)發(fā)工具和軟件結(jié)構(gòu)，表示形式可能是：插件、組件、控件，函數(shù)、過(guò)程、子程序，存儲(chǔ)過(guò)程，動(dòng)態(tài)連接庫(kù)，等等。運(yùn)行環(huán)境描述該部件所適合的運(yùn)行環(huán)境，即說(shuō)明該部件是針對(duì)何種運(yùn)行環(huán)境所開(kāi)發(fā)的；可以直接描述運(yùn)行環(huán)境，也可以描述運(yùn)行環(huán)境的編號(hào)；對(duì)于實(shí)行配置管理的軟件開(kāi)發(fā)項(xiàng)目來(lái)說(shuō)，該描述必須與該部件在配置管

11、理中的描相同。性能要求指開(kāi)發(fā)該部件時(shí)必須滿(mǎn)足的專(zhuān)門(mén)要求，這些要求可以是：精度靈活性響應(yīng)時(shí)間可重用性等等。提出的要求一般不宜超過(guò)3項(xiàng)，以排列的先后順序表示優(yōu)先級(jí)。詞匯表列出本文件中用到的專(zhuān)業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫(xiě)的定義(如有可能，列出相關(guān)的外文原詞)。為了便于非軟件專(zhuān)業(yè)或者非計(jì)算機(jī)專(zhuān)業(yè)人士也能夠在一定的范圍內(nèi)，讀懂軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告，要求盡可能使用非軟件專(zhuān)業(yè)或者非計(jì)算機(jī)專(zhuān)業(yè)的術(shù)語(yǔ)進(jìn)行描述。所以這里所指的專(zhuān)業(yè)術(shù)語(yǔ)，是指業(yè)務(wù)層面上的專(zhuān)業(yè)術(shù)語(yǔ)，而不是軟件專(zhuān)業(yè)或者計(jì)算機(jī)專(zhuān)業(yè)的術(shù)語(yǔ)。但是，對(duì)于無(wú)法回避的軟件專(zhuān)業(yè)或者計(jì)算機(jī)專(zhuān)業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。部件表格式部件編號(hào)部件名稱(chēng)所屬子系統(tǒng)部件調(diào)用者部件被調(diào)用者部件入口參數(shù)部件入口參數(shù)算法：流程描述：表示性能運(yùn)行環(huán)境性能要求說(shuō)明：如果軟件不見(jiàn)使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表的續(xù)表。界面表格式界面編號(hào)部件名稱(chēng)界面性質(zhì)界面介質(zhì)表示形式：界面參數(shù)參數(shù)名內(nèi)容說(shuō)明說(shuō)明：如果軟件不見(jiàn)使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表的續(xù)表。發(fā)文字號(hào)：發(fā)文字號(hào)：居中；三號(hào)仿宋體體字201號(hào)主送機(jī)關(guān)：標(biāo)題下空主送機(jī)關(guān)：標(biāo)題下空1行；左側(cè)頂格；3號(hào)仿宋體標(biāo)題：居中；小2號(hào)宋體加粗關(guān)于的正文：正