R02-軟件開(kāi)發(fā)設(shè)計(jì)規(guī)范模板

v1.0可編輯可修改PAGE106附錄B軟件概要設(shè)計(jì)報(bào)告文檔模板7621附錄B軟件概要設(shè)計(jì)報(bào)告文檔模板 186981.引言 4323681.1編寫(xiě)目的 4315501.2項(xiàng)目風(fēng)險(xiǎn) 497101.3預(yù)期讀者和閱讀建議 4316201.4參考資料 538462.設(shè)計(jì)概述 561742.1限制和約束 6288392.2設(shè)計(jì)原則和設(shè)計(jì)要求 639803.系統(tǒng)邏輯設(shè)計(jì) 6280463.1系統(tǒng)組織設(shè)計(jì) 7181463.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 8139613.2.1系統(tǒng)特性表 8132133.2.2系統(tǒng)特性結(jié)構(gòu)圖 9234203.3系統(tǒng)接口設(shè)計(jì) 10156143.3.1系統(tǒng)接口表 10106973.3.2系統(tǒng)接口傳輸協(xié)議說(shuō)明 1164993.4系統(tǒng)完整性設(shè)計(jì) 12109644.系統(tǒng)出錯(cuò)處理設(shè)計(jì) 1338924.1系統(tǒng)出錯(cuò)處理表 13111834.2維護(hù)處理過(guò)程表 14323445.技術(shù)設(shè)計(jì) 16161905.1系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表 16323465.2開(kāi)發(fā)技術(shù)應(yīng)用說(shuō)明 17302826.數(shù)據(jù)庫(kù)設(shè)計(jì) 17324167.詞匯表 1895658.進(jìn)度計(jì)劃 18349附錄C軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板 1836831.引言 2538881.1編寫(xiě)目的 25134051.2項(xiàng)目風(fēng)險(xiǎn) 25124221.3文檔約定 2545271.4預(yù)期讀者和閱讀建議 26253981.5參考資料 26281072.支撐環(huán)境 27302042.1數(shù)據(jù)庫(kù)管理系統(tǒng) 27136402.2開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口 28165652.3硬件環(huán)境 2940102.4網(wǎng)絡(luò)環(huán)境 29101232.5多種支撐環(huán)境開(kāi)發(fā)要點(diǎn) 2921423.部件詳細(xì)設(shè)計(jì) 3021604.詞匯表 3232675.部件表格式 32280676.界面表格式 3320266附錄D軟件數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告文檔模板 36299621.引言 42243801.1編寫(xiě)目的 4270761.2項(xiàng)目來(lái)源 4225961.3文檔約定 42218671.4預(yù)期讀者和閱讀建議 42269881.5參考資料 43238962.數(shù)據(jù)庫(kù)命名規(guī)則 44321183.數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明 44180223.1數(shù)據(jù)庫(kù)邏輯設(shè)計(jì) 44227663.2數(shù)據(jù)庫(kù)物理設(shè)計(jì) 44240013.3數(shù)據(jù)庫(kù)分布 44196323.4基表設(shè)計(jì) 45121843.5視圖設(shè)計(jì) 47163723.6索引設(shè)計(jì) 49192223.7完整性約束 50324453.8授權(quán)設(shè)計(jì) 5019393.9觸發(fā)器設(shè)計(jì) 51227503.10存儲(chǔ)過(guò)程設(shè)計(jì) 52235603.11數(shù)據(jù)復(fù)制設(shè)計(jì) 53322784.詞匯表 5490205.歷史數(shù)據(jù)處理 55102526.測(cè)試結(jié)果交付方式 56引言引言是對(duì)這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔是如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求規(guī)格說(shuō)明書(shū)編寫(xiě)的，開(kāi)發(fā)這個(gè)軟件產(chǎn)品意義、作用、以及最終要達(dá)到的意圖。通過(guò)這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告詳盡說(shuō)明了該軟件產(chǎn)品的軟件結(jié)構(gòu)，包括數(shù)據(jù)庫(kù)結(jié)構(gòu)和出錯(cuò)處理，從而對(duì)該軟件產(chǎn)品的結(jié)構(gòu)的描述。如果這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義軟件系統(tǒng)概要設(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ā)者；產(chǎn)品使用者。預(yù)期讀者和閱讀建議列舉本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告所針對(duì)的各種不同的預(yù)期讀者，例如，可能的讀者包括：用戶；開(kāi)發(fā)人員；項(xiàng)目經(jīng)理；營(yíng)銷人員；測(cè)試人員；文檔編寫(xiě)人員；等等。描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫(xiě)軟件產(chǎn)品概要設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括：本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；系統(tǒng)規(guī)格需求說(shuō)明；使用實(shí)例文檔；屬于本項(xiàng)目的其它已發(fā)表文件；本軟件系統(tǒng)概要設(shè)計(jì)報(bào)告中所引用的文件、資料：相關(guān)軟件系統(tǒng)概要設(shè)計(jì)報(bào)告：等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順排列。如果可能，每份資料都應(yīng)該給出：標(biāo)題名稱；作者或者合同簽約者；文件編號(hào)或者版本號(hào)；發(fā)表日期或者簽約日期；出版單位或者資料來(lái)源。設(shè)計(jì)概述本節(jié)描述現(xiàn)有開(kāi)發(fā)條件和需要實(shí)現(xiàn)的目標(biāo)，說(shuō)明進(jìn)行概要設(shè)計(jì)時(shí)應(yīng)該遵循的設(shè)計(jì)原則和必須采用的設(shè)計(jì)方法。限制和約束簡(jiǎn)要描述起到限制和約束作用的各種可能存在的條件，例如：技術(shù)條件；資金狀況；開(kāi)發(fā)環(huán)境(包括：工具和平臺(tái))；時(shí)間限制；等等。并且說(shuō)明在上述條件下，應(yīng)該實(shí)現(xiàn)的系統(tǒng)目標(biāo)，設(shè)計(jì)原則和設(shè)計(jì)要求描述對(duì)本軟件系統(tǒng)進(jìn)行概要設(shè)計(jì)的原則，通常可以考慮以下幾方面的內(nèi)容：命名規(guī)則；模塊獨(dú)立性原則：邊界設(shè)計(jì)原則；數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)則；必須的安全措施；安全性和保密原則；系統(tǒng)靈活性要求；系統(tǒng)易操作性要求；系統(tǒng)可維護(hù)性要求；等等。系統(tǒng)邏輯設(shè)計(jì)本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說(shuō)明書(shū)和軟件產(chǎn)品數(shù)據(jù)字典建立系統(tǒng)的邏輯模型。此種模型暫時(shí)與系統(tǒng)的物理因素(例如：計(jì)算機(jī)、數(shù)據(jù)庫(kù)管理系統(tǒng))無(wú)關(guān)。它是系統(tǒng)需求與物理實(shí)現(xiàn)的中間結(jié)構(gòu)，它的主要結(jié)果是建立：系統(tǒng)結(jié)構(gòu)圖、系統(tǒng)界面結(jié)構(gòu)圖、系統(tǒng)出錯(cuò)處理、以及系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明。說(shuō)明：如果進(jìn)行系統(tǒng)設(shè)計(jì)時(shí)尚未編寫(xiě)軟件數(shù)據(jù)字典：應(yīng)首先參照附錄B說(shuō)明，編寫(xiě)軟件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后，再進(jìn)行系統(tǒng)設(shè)計(jì)。系統(tǒng)組織設(shè)計(jì)系統(tǒng)組織設(shè)計(jì)通過(guò)系統(tǒng)組織表描述本系統(tǒng)由哪些子系統(tǒng)(模塊)組成，這些子系統(tǒng)與業(yè)務(wù)職能之間的關(guān)系，以及各個(gè)子系統(tǒng)的安裝地點(diǎn)。系統(tǒng)組織表的格式如下：子系統(tǒng)編號(hào)英文名稱中文名稱業(yè)務(wù)職能安裝地點(diǎn)備注其中：子系統(tǒng)編號(hào)給出本系統(tǒng)中指定子系統(tǒng)的順序編號(hào)。如果本系統(tǒng)末劃分為多個(gè)子系統(tǒng)，僅由一個(gè)運(yùn)行模塊組成；則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。說(shuō)明：在一個(gè)系統(tǒng)中有可能安裝若干個(gè)相同的子系統(tǒng)，在這種情況下，應(yīng)該視為一個(gè)子系統(tǒng)，并且對(duì)多個(gè)安裝地點(diǎn)分別進(jìn)行描述。如果相同的子系統(tǒng)通過(guò)系統(tǒng)設(shè)置，實(shí)現(xiàn)的業(yè)務(wù)職能具有明顯差異時(shí)，應(yīng)該采用多行進(jìn)行分別描述，并且在備注中說(shuō)明其差異所在。子系統(tǒng)英文名稱給出本子系統(tǒng)的英文名稱，該名稱是在應(yīng)用軟件中實(shí)際使用的可執(zhí)行文件名稱，必須能夠說(shuō)明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng)，則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。子系統(tǒng)中文名稱給出本子系統(tǒng)的中文名稱，該名稱必須能夠說(shuō)明該子系統(tǒng)的特點(diǎn)。若本系統(tǒng)中只有一個(gè)子系統(tǒng)，則本項(xiàng)內(nèi)容仍需要描述，但是本表內(nèi)容只有一行。業(yè)務(wù)職能描述該子系統(tǒng)完成的核心業(yè)務(wù)。安裝地點(diǎn)描述該子系統(tǒng)實(shí)際安裝的部門(mén)、或者某個(gè)具體地點(diǎn)。備注針對(duì)該子系統(tǒng)，需要說(shuō)明的其它有關(guān)問(wèn)題。系統(tǒng)結(jié)構(gòu)設(shè)計(jì)本節(jié)將對(duì)系統(tǒng)特性作較為詳細(xì)的描述，并給出系統(tǒng)特性結(jié)構(gòu)圖。系統(tǒng)特性表系統(tǒng)特性是系統(tǒng)中完成某項(xiàng)具體操作的基本單元，它由入口參數(shù)，出口參數(shù)以及處理過(guò)程三部分組成。系統(tǒng)特性可以具有操作界面，也可以沒(méi)有操作界面；可以被其它操作界面、或者系統(tǒng)特性調(diào)用，也可以調(diào)用其它操作界面、非操作界面、或者系統(tǒng)特性；但是不允許遞歸調(diào)用(調(diào)用自己)，包括間接遞歸調(diào)用。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)特性表進(jìn)行描述。系統(tǒng)特性表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：特性編號(hào)系統(tǒng)特征英文名稱系統(tǒng)特征中文名稱操作功能調(diào)用對(duì)象被調(diào)用對(duì)象備注說(shuō)明：其中子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。特性編號(hào)整個(gè)系統(tǒng)所有特性的統(tǒng)一編號(hào)。系統(tǒng)特性英文名稱系統(tǒng)特性的英文正式名稱，將來(lái)用于軟件開(kāi)發(fā)中，必須符合命名規(guī)范。系統(tǒng)特性中文名稱系統(tǒng)特性的中文正式名稱，來(lái)源于需求規(guī)格說(shuō)明書(shū)中，系統(tǒng)特性一節(jié)中的有關(guān)描述。操作功能是指該特性實(shí)際完成的操作說(shuō)明。調(diào)用對(duì)象是指調(diào)用該系統(tǒng)特性的系統(tǒng)對(duì)象，這里的系統(tǒng)對(duì)象可以是系統(tǒng)特性、也可以是操作界面。被調(diào)用對(duì)象是指被該系統(tǒng)特性調(diào)用的系統(tǒng)對(duì)象，這里的系統(tǒng)對(duì)象可以是系統(tǒng)特性、也可以是操作界面。說(shuō)明：某些較低層的系統(tǒng)特性，可能不存在被調(diào)用對(duì)象。備注描述與該系統(tǒng)特性有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)特性表有關(guān)的其它注意事項(xiàng)。系統(tǒng)特性結(jié)構(gòu)圖系統(tǒng)特性結(jié)構(gòu)圖給出系統(tǒng)特性在邏輯層面上相互之間的關(guān)系，其主要依據(jù)來(lái)源于需求規(guī)格說(shuō)明書(shū)中，系統(tǒng)特性一節(jié)中的有關(guān)描述。如果系統(tǒng)劃分為多個(gè)子系統(tǒng)，應(yīng)分別給出系統(tǒng)與子系統(tǒng)、以及各個(gè)子系統(tǒng)與系統(tǒng)特性的結(jié)構(gòu)圖。繪制系統(tǒng)與子系統(tǒng)結(jié)構(gòu)圖時(shí)，一般不需要描繪出系統(tǒng)特性，如果確有必要，盡可能只畫(huà)出第一層系統(tǒng)特性。繪制子系統(tǒng)與系統(tǒng)特性結(jié)構(gòu)圖時(shí)，通常也不需要描繪出第二層系統(tǒng)特性，如果確有必要可以畫(huà)出，但是盡可能不要畫(huà)出第三層系統(tǒng)特性。系統(tǒng)接口設(shè)計(jì)系統(tǒng)接口是一種非可視的系統(tǒng)界面，在多數(shù)情況下，它對(duì)用戶是透明的。本節(jié)將對(duì)系統(tǒng)接口作較為詳細(xì)的描述，并給出接口說(shuō)明清單。系統(tǒng)接口表接口作為系統(tǒng)的一種輸入／輸出形式，分為網(wǎng)絡(luò)接口、數(shù)據(jù)庫(kù)接口、RS-232串行通訊接口、IEEE—485串行總線接口、并行I/O接口等等多種類型。對(duì)于一些為可視界面服務(wù)的接口，例如：打印機(jī)接口、顯示器接口等，因?yàn)檫@類接口對(duì)應(yīng)用軟件是透明的，所以不在本節(jié)描述范圍內(nèi)。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)接口表進(jìn)行描述。系統(tǒng)接口表的格式如下：子系統(tǒng)編號(hào)子系統(tǒng)英文名稱子系統(tǒng)中文名稱接口編號(hào)接口名稱接口類型接口性質(zhì)接口速率接口協(xié)議備注說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。接口編號(hào)整個(gè)系統(tǒng)所有接口的統(tǒng)一編號(hào)。接口名稱系統(tǒng)接口的正式名稱，必須符合通常習(xí)慣。接口類型指出該接口所傳輸?shù)臄?shù)據(jù)在該模塊中起到的作用。接口性質(zhì)指出該接口在通訊中起到的作用，這里的作用可以是：輸入；輸出；雙向。接口速率指出該接口的傳輸速率。如果該接口依賴于其它通訊方式，那么傳輸速率將不高于它所依賴的其它通訊方式的速率。接口協(xié)議給出該接口實(shí)際使用的通訊協(xié)議。相關(guān)對(duì)象給出直接使用本接口的系統(tǒng)對(duì)象，這里的系統(tǒng)對(duì)象，可以是操作界面，也可以是系統(tǒng)特性。備注描述與該系統(tǒng)接口有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)接口表有關(guān)的其它注意事項(xiàng)。系統(tǒng)接口傳輸協(xié)議說(shuō)明逐項(xiàng)詳細(xì)描述系統(tǒng)接口表中所列出各個(gè)系統(tǒng)接口使用的傳輸協(xié)議，以及其它相關(guān)內(nèi)容，例如：驅(qū)動(dòng)程序、動(dòng)態(tài)連接庫(kù)、等等。系統(tǒng)完整性設(shè)計(jì)描述系統(tǒng)對(duì)象(數(shù)據(jù)元、數(shù)據(jù)類)，所受到的邏輯約束關(guān)系。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)應(yīng)分別使用一張系統(tǒng)完整性約束表進(jìn)行描述。系統(tǒng)完整性約束表的格式如下：子系統(tǒng)編號(hào)子系統(tǒng)英文名稱子系統(tǒng)中文名稱約束編號(hào)完整性名稱相對(duì)對(duì)象名約束表達(dá)式備注說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。約束編號(hào)整個(gè)系統(tǒng)所有約束的統(tǒng)一編號(hào)。完整性名稱系統(tǒng)完整性約束的正式名稱，必須符合通常習(xí)慣。相對(duì)對(duì)象名完整性約束中的相關(guān)對(duì)象(數(shù)據(jù)元和數(shù)據(jù)類)。約束表達(dá)式用一階邏輯表達(dá)式表達(dá)的約束方程式。備注描述與該系統(tǒng)完整性約束有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)完整性約束表有關(guān)的其它注意事項(xiàng)。系統(tǒng)出錯(cuò)處理設(shè)計(jì)本節(jié)描述系統(tǒng)發(fā)生外界及內(nèi)在錯(cuò)誤時(shí)，所提供的錯(cuò)誤信息及處理方法，它包括系統(tǒng)出錯(cuò)處理表及維護(hù)處理過(guò)程表。系統(tǒng)出錯(cuò)處理表本表給出有關(guān)出錯(cuò)處理的產(chǎn)生原因、提示信息、以及建議處理方法。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)出錯(cuò)處理表進(jìn)行描述。系統(tǒng)出錯(cuò)處理表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯(cuò)誤編號(hào)錯(cuò)誤名稱錯(cuò)誤原因錯(cuò)誤信息處理方式備注說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。錯(cuò)誤編號(hào)整個(gè)系統(tǒng)所有錯(cuò)誤的統(tǒng)一編號(hào)。錯(cuò)誤名稱錯(cuò)誤的正式名稱，該名稱應(yīng)該是常用的，并且為人們所普遍接受的。錯(cuò)誤原因?qū)υ撳e(cuò)誤產(chǎn)生原因的解釋與說(shuō)明。錯(cuò)誤信息產(chǎn)生該錯(cuò)誤時(shí)，向用戶發(fā)出的提示信息。處理方式對(duì)該錯(cuò)誤處理的一種建議，此項(xiàng)允許缺省。備注描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。維護(hù)處理過(guò)程表系統(tǒng)出錯(cuò)時(shí)，將調(diào)用維護(hù)處理過(guò)程對(duì)錯(cuò)誤進(jìn)行處理，有關(guān)維護(hù)處理過(guò)程的各項(xiàng)內(nèi)容由維護(hù)處理過(guò)程表進(jìn)行描述。當(dāng)系統(tǒng)有多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張維護(hù)處理過(guò)程表進(jìn)行描述。維護(hù)處理過(guò)程表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：錯(cuò)誤編號(hào)處理過(guò)程處理過(guò)程處理功能入口參數(shù)出口參數(shù)備注英文名稱中文名稱說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。錯(cuò)誤編號(hào)含義同上。處理過(guò)程英文名稱系統(tǒng)維護(hù)處理過(guò)程的英文正式名稱，將來(lái)用于軟件開(kāi)發(fā)中，必須符合命名規(guī)范。處理過(guò)程中文名稱系統(tǒng)維護(hù)處理過(guò)程的中文正式名稱，是系統(tǒng)維護(hù)處理過(guò)程英文名稱的中文說(shuō)明。處理功能描述本維護(hù)處理過(guò)程對(duì)錯(cuò)誤的處理方式。由于一個(gè)維護(hù)處理過(guò)程有可能具有對(duì)多個(gè)錯(cuò)誤進(jìn)行處理的能力，因此該處理功能必須是針對(duì)本項(xiàng)錯(cuò)誤編號(hào)的。入口參數(shù)進(jìn)行本項(xiàng)錯(cuò)誤處理時(shí)，賦給維護(hù)處理過(guò)程的入口參數(shù)。出口參數(shù)進(jìn)行本項(xiàng)錯(cuò)誤處理時(shí)，維護(hù)處理過(guò)程返回的出口參數(shù)。備注描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。技術(shù)設(shè)計(jì)系統(tǒng)技術(shù)設(shè)計(jì)描述系統(tǒng)各個(gè)特性實(shí)際使用的開(kāi)發(fā)技術(shù)，以及具體開(kāi)發(fā)技術(shù)使用時(shí)應(yīng)該注意的事項(xiàng)。系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表本表描述系統(tǒng)各個(gè)特性開(kāi)發(fā)時(shí)實(shí)際使用的具體技術(shù)，只有一些不太常用的技術(shù)需要在這里描述。一些常用技術(shù)，例如：通過(guò)數(shù)據(jù)庫(kù)接口調(diào)用存儲(chǔ)過(guò)程，則不必冗述。當(dāng)系統(tǒng)由多個(gè)子系統(tǒng)(模塊)組成時(shí)，每個(gè)子系統(tǒng)分別使用一張系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表進(jìn)行描述。系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表的格式如下：子系統(tǒng)編號(hào)：子系統(tǒng)英文名稱：子系統(tǒng)中文名稱：技術(shù)編號(hào)開(kāi)發(fā)技術(shù)開(kāi)發(fā)技術(shù)處理功能系統(tǒng)特性編號(hào)備注英文名稱中文名稱說(shuō)明：其中：子系統(tǒng)編號(hào)含義同上。子系統(tǒng)英文名稱含義同上。子系統(tǒng)中文名稱含義同上。技術(shù)編號(hào)這個(gè)系統(tǒng)所使用各種技術(shù)的統(tǒng)一編號(hào)。開(kāi)發(fā)技術(shù)英文名稱該開(kāi)發(fā)技術(shù)的英文正式名稱，可以便用縮寫(xiě)。該名稱應(yīng)該是常用的，并且為人們所普遍接受的。開(kāi)發(fā)技術(shù)中文名稱該開(kāi)發(fā)技術(shù)的中文正式名稱，是該開(kāi)發(fā)技術(shù)英文名稱的中文說(shuō)明。該名稱應(yīng)該是常用的，并且為人們所普遍接受的。處理功能描述本開(kāi)發(fā)技術(shù)的處理目的。系統(tǒng)特性編號(hào)含義同上。由于一項(xiàng)開(kāi)發(fā)技術(shù)可能在多處使用，因此針對(duì)一項(xiàng)開(kāi)發(fā)技術(shù)，有可能存在多個(gè)系統(tǒng)特性編號(hào)，在此必須一一列出。備注描述與該系統(tǒng)開(kāi)發(fā)技術(shù)相關(guān)的其它注意事項(xiàng)。說(shuō)明描述與該系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表有關(guān)的其它注意事項(xiàng)。開(kāi)發(fā)技術(shù)應(yīng)用說(shuō)明逐項(xiàng)詳細(xì)描述系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表中所列出各項(xiàng)系統(tǒng)開(kāi)發(fā)技術(shù)使用的技術(shù)要點(diǎn)，以及其它相關(guān)內(nèi)容，例如：所需的服務(wù)、使用的動(dòng)態(tài)連接庫(kù)、調(diào)用的組件、等等。數(shù)據(jù)庫(kù)設(shè)計(jì)如果該軟件產(chǎn)品需要使用數(shù)據(jù)庫(kù)，不論是使用數(shù)據(jù)庫(kù)平臺(tái)支撐的，還是采用由軟件產(chǎn)品開(kāi)發(fā)者自行定義的；都應(yīng)該在完成軟件產(chǎn)品需求分析報(bào)告后，開(kāi)始進(jìn)行軟件產(chǎn)品詳細(xì)設(shè)計(jì)之前，按照軟件產(chǎn)品數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明文檔模板完成數(shù)據(jù)庫(kù)設(shè)計(jì)工作。詞匯表列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫(xiě)的定義(如有可能，列出相關(guān)的外文原向)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士閱讀軟件系統(tǒng)概要設(shè)計(jì)報(bào)告，要求使用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)進(jìn)行描述。所以這里所指的專業(yè)術(shù)語(yǔ)，是指業(yè)務(wù)層面上的專業(yè)術(shù)語(yǔ)，而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)。但是，對(duì)于無(wú)法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。進(jìn)度計(jì)劃列出進(jìn)度計(jì)劃，包括各子系統(tǒng)、各子模塊完成進(jìn)度計(jì)劃，人員配備計(jì)劃等。附錄C軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板1.范圍 12.總體要求 12.1總體功能要求 12.2軟件開(kāi)發(fā)平臺(tái)要求 12.3軟件項(xiàng)目的開(kāi)發(fā)實(shí)施過(guò)程管理要求 22.3.1軟件項(xiàng)目實(shí)施過(guò)程總體要求 22.3.2軟件項(xiàng)目實(shí)施變更要求 22.3.3軟件項(xiàng)目實(shí)施里程碑控制 33.軟件開(kāi)發(fā) 43.1軟件的需求分析 43.1.1需求分析 43.1.2需求分析報(bào)告的編制者 53.1.3需求報(bào)告評(píng)審 53.1.4需求報(bào)告格式 53.2軟件的概要設(shè)計(jì) 53.2.1概要設(shè)計(jì) 53.2.2編寫(xiě)概要設(shè)計(jì)的要求 63.2.3概要設(shè)計(jì)報(bào)告的編寫(xiě)者 63.2.4概要設(shè)計(jì)和需求分析、詳細(xì)設(shè)計(jì)之間的關(guān)系和區(qū)別 63.2.5概要設(shè)計(jì)的評(píng)審 63.2.6概要設(shè)計(jì)格式 63.3軟件的詳細(xì)設(shè)計(jì) 73.3.1詳細(xì)設(shè)計(jì) 73.3.2特例 73.3.3詳細(xì)設(shè)計(jì)的要求 73.3.4數(shù)據(jù)庫(kù)設(shè)計(jì) 73.3.5詳細(xì)設(shè)計(jì)的評(píng)審 73.3.6詳細(xì)設(shè)計(jì)格式 83.4軟件的編碼 83.4.1軟件編碼 83.4.2軟件編碼的要求 83.4.3編碼的評(píng)審 83.4.4編程規(guī)范及要求 83.5軟件的測(cè)試 93.5.1軟件測(cè)試 93.5.2測(cè)試計(jì)劃 93.6軟件的交付準(zhǔn)備 93.6.1交付清單 93.7軟件的鑒定驗(yàn)收 103.7.1軟件的鑒定驗(yàn)收 103.7.2驗(yàn)收人員 103.7.3驗(yàn)收具體內(nèi)容 103.7.4軟件驗(yàn)收測(cè)試大綱 113.8培訓(xùn) 113.8.1系統(tǒng)應(yīng)用培訓(xùn) 113.8.2系統(tǒng)管理的培訓(xùn)（可選） 111.引言 191.1編寫(xiě)目的 191.2項(xiàng)目風(fēng)險(xiǎn) 191.3文檔約定 191.4預(yù)期讀者和閱讀建議 201.5產(chǎn)品范圍 201.6參考文獻(xiàn) 202.綜合描述 212.1產(chǎn)品的狀況 212.2產(chǎn)品的功能 222.3用戶類和特性 222.4運(yùn)行環(huán)境 222.5設(shè)計(jì)和實(shí)現(xiàn)上的限制 232.6假設(shè)和約束(依賴) 233.外部接口需求 243.1用戶界面 243.2硬件接口 253.3軟件接口 253.4通訊接口 264.系統(tǒng)功能需求 264.1說(shuō)明和優(yōu)先級(jí) 274.2激勵(lì)／響應(yīng)序列 274.3輸入／輸出數(shù)據(jù) 285.其它非功能需求 285.1性能需求 285.2安全措施需求 295.3安全性需求 295.4軟件質(zhì)量屬性 295.5業(yè)務(wù)規(guī)則 295.6用戶文檔 306.詞匯表 307.數(shù)據(jù)定義 308.分析模型 329.待定問(wèn)題列表 321.引言 391.1編寫(xiě)目的 391.2項(xiàng)目風(fēng)險(xiǎn) 391.3預(yù)期讀者和閱讀建議 391.4參考資料 402.設(shè)計(jì)概述 402.1限制和約束 412.2設(shè)計(jì)原則和設(shè)計(jì)要求 413.系統(tǒng)邏輯設(shè)計(jì) 413.1系統(tǒng)組織設(shè)計(jì) 423.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 433.2.1系統(tǒng)特性表 433.2.2系統(tǒng)特性結(jié)構(gòu)圖 443.3系統(tǒng)接口設(shè)計(jì) 453.3.1系統(tǒng)接口表 453.3.2系統(tǒng)接口傳輸協(xié)議說(shuō)明 463.4系統(tǒng)完整性設(shè)計(jì) 474.系統(tǒng)出錯(cuò)處理設(shè)計(jì) 484.1系統(tǒng)出錯(cuò)處理表 484.2維護(hù)處理過(guò)程表 495.技術(shù)設(shè)計(jì) 515.1系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表 515.2開(kāi)發(fā)技術(shù)應(yīng)用說(shuō)明 526.數(shù)據(jù)庫(kù)設(shè)計(jì) 527.詞匯表 538.進(jìn)度計(jì)劃 531.引言 601.1編寫(xiě)目的 601.2項(xiàng)目風(fēng)險(xiǎn) 601.3文檔約定 601.4預(yù)期讀者和閱讀建議 611.5參考資料 612.支撐環(huán)境 622.1數(shù)據(jù)庫(kù)管理系統(tǒng) 622.2開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口 632.3硬件環(huán)境 642.4網(wǎng)絡(luò)環(huán)境 642.5多種支撐環(huán)境開(kāi)發(fā)要點(diǎn) 643.部件詳細(xì)設(shè)計(jì) 654.詞匯表 675.部件表格式 676.界面表格式 681.引言 771.1編寫(xiě)目的 771.2項(xiàng)目來(lái)源 771.3文檔約定 771.4預(yù)期讀者和閱讀建議 771.5參考資料 782.數(shù)據(jù)庫(kù)命名規(guī)則 793.數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明 793.1數(shù)據(jù)庫(kù)邏輯設(shè)計(jì) 793.2數(shù)據(jù)庫(kù)物理設(shè)計(jì) 793.3數(shù)據(jù)庫(kù)分布 793.4基表設(shè)計(jì) 803.5視圖設(shè)計(jì) 823.6索引設(shè)計(jì) 843.7完整性約束 853.8授權(quán)設(shè)計(jì) 853.9觸發(fā)器設(shè)計(jì) 863.10存儲(chǔ)過(guò)程設(shè)計(jì) 873.11數(shù)據(jù)復(fù)制設(shè)計(jì) 884.詞匯表 895.歷史數(shù)據(jù)處理 901.引言 981.1目的 981.2術(shù)語(yǔ) 981.3參照標(biāo)準(zhǔn) 982.測(cè)試日期安排 993.測(cè)試小組及成員 994.測(cè)試具體內(nèi)容 994.1合法性檢查 1004.2軟件文檔檢查 1004.2.1必須提供檢查的文檔 1004.2.2其他可能需要檢查的文檔 1004.2.3由業(yè)主確定必須檢查的其他文檔 1004.2.4文檔質(zhì)量的度量準(zhǔn)則 1014.3軟件代碼測(cè)試 1024.3.1源代碼一般性檢查 1024.3.2軟件一致性檢查 1024.4軟件系統(tǒng)測(cè)試 1034.4.1界面(外觀)測(cè)試 1034.4.2可用性測(cè)試 1044.4.3功能測(cè)試 1044.4.4穩(wěn)定性(強(qiáng)度)測(cè)試 1044.4.5性能測(cè)試 1044.4.6強(qiáng)壯性(恢復(fù))測(cè)試 1044.4.7邏輯性測(cè)試 1044.4.8破壞性測(cè)試 1054.4.9安全性測(cè)試 1055.測(cè)試結(jié)果交付方式 105

引言引言是對(duì)這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求分析報(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ā)者；產(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ì)每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫(xiě)軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括：本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；用戶界面風(fēng)格指導(dǎo)；開(kāi)發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)難；系統(tǒng)規(guī)格需求說(shuō)明；使用實(shí)例文檔；屬于本項(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)題名稱；作者或者合同簽約者；文件編號(hào)或者版本號(hào)；發(fā)表日期或者簽約日期；出版單位或者資料來(lái)源。支撐環(huán)境數(shù)據(jù)庫(kù)管理系統(tǒng)描述數(shù)據(jù)庫(kù)管理系統(tǒng)、以及安裝配置情況，需要描述的內(nèi)容可能包括：產(chǎn)品名稱以及發(fā)行廠商這里的產(chǎn)品名稱指的是數(shù)據(jù)庫(kù)發(fā)行廠商發(fā)布產(chǎn)品時(shí)公布的正式商品名稱，不應(yīng)該使用別名、簡(jiǎn)稱、研發(fā)代號(hào)等非正式名稱，以免混淆；同樣的道理，發(fā)行廠商的名稱也應(yīng)該使用正式名稱。版本號(hào)數(shù)據(jù)庫(kù)管理系統(tǒng)的準(zhǔn)確版本號(hào)，必須按產(chǎn)品的實(shí)際情況描述到最細(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ù)管理系統(tǒng)的配置參數(shù)。等等同時(shí)參照《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》。開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口描述所選用的工具軟件和中間件的名稱、版本號(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)品名稱以及發(fā)行廠商同中產(chǎn)品名稱以及發(fā)行廠商。版本號(hào)同中版本號(hào)。補(bǔ)丁包版本號(hào)同中補(bǔ)丁包版本號(hào)。語(yǔ)言或代碼集同中語(yǔ)言或代碼集。數(shù)據(jù)庫(kù)接口名稱描述數(shù)據(jù)庫(kù)接口的名稱，如果使用別名時(shí)，應(yīng)同時(shí)描述使用的別名。數(shù)據(jù)庫(kù)接口方式描述與數(shù)據(jù)庫(kù)接口的方式，并說(shuō)明該接口方式的特點(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)境，如果存在加密傳輸、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鏈路連接方式；等等。多種支撐環(huán)境開(kāi)發(fā)要點(diǎn)當(dāng)軟件產(chǎn)品將來(lái)可能遇到的多種運(yùn)行環(huán)境時(shí)，應(yīng)該分別按照節(jié)至節(jié)的內(nèi)容列表描述。如果軟件產(chǎn)品各個(gè)子系統(tǒng)的運(yùn)行環(huán)境不完全一樣時(shí)，應(yīng)該分子系統(tǒng)按照節(jié)至節(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ì)情況。描述的順序可以是按層次橫向進(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)相同。部件名稱軟件部件的正式英文名稱，該名稱是程序中使用的實(shí)際名稱，必須符合國(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)和名稱。部件被調(diào)用者指被該部件所調(diào)用的部件的編號(hào)和名稱。部件入口參數(shù)指該部件入口數(shù)據(jù)類名稱或者數(shù)據(jù)名稱，以及對(duì)這些數(shù)據(jù)的描述；如果部件沒(méi)有入口參數(shù)，該欄為空。部件出口參數(shù)指該部件出口數(shù)據(jù)類名稱或者數(shù)據(jù)名稱，以及對(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ō)，該描述必須與該部件在配置管理中的描相同。性能要求指開(kāi)發(fā)該部件時(shí)必須滿足的專門(mén)要求，這些要求可以是：精度靈活性響應(yīng)時(shí)間可重用性等等。提出的要求一般不宜超過(guò)3項(xiàng)，以排列的先后順序表示優(yōu)先級(jí)。詞匯表列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫(xiě)的定義(如有可能，列出相關(guān)的外文原詞)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士也能夠在一定的范圍內(nèi)，讀懂軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告，要求盡可能使用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)進(jìn)行描述。所以這里所指的專業(yè)術(shù)語(yǔ)，是指業(yè)務(wù)層面上的專業(yè)術(shù)語(yǔ)，而不是軟件專業(yè)或者計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)。但是，對(duì)于無(wú)法回避的軟件專業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。部件表格式部件編號(hào)部件名稱所屬子系統(tǒng)部件調(diào)用者部件被調(diào)用者部件入口參數(shù)部件入口參數(shù)算法：流程描述：表示性能運(yùn)行環(huán)境性能要求說(shuō)明：如果軟件不見(jiàn)使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表的續(xù)表。界面表格式界面編號(hào)部件名稱界面性質(zhì)界面介質(zhì)表示形式：界面參數(shù)參數(shù)名內(nèi)容說(shuō)明說(shuō)明：如果軟件不見(jiàn)使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表的續(xù)表。附錄D軟件數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告文檔模板1.范圍 12.總體要求 12.1總體功能要求 12.2軟件開(kāi)發(fā)平臺(tái)要求 12.3軟件項(xiàng)目的開(kāi)發(fā)實(shí)施過(guò)程管理要求 22.3.1軟件項(xiàng)目實(shí)施過(guò)程總體要求 22.3.2軟件項(xiàng)目實(shí)施變更要求 22.3.3軟件項(xiàng)目實(shí)施里程碑控制 33.軟件開(kāi)發(fā) 43.1軟件的需求分析 43.1.1需求分析 43.1.2需求分析報(bào)告的編制者 53.1.3需求報(bào)告評(píng)審 53.1.4需求報(bào)告格式 53.2軟件的概要設(shè)計(jì) 53.2.1概要設(shè)計(jì) 53.2.2編寫(xiě)概要設(shè)計(jì)的要求 63.2.3概要設(shè)計(jì)報(bào)告的編寫(xiě)者 63.2.4概要設(shè)計(jì)和需求分析、詳細(xì)設(shè)計(jì)之間的關(guān)系和區(qū)別 63.2.5概要設(shè)計(jì)的評(píng)審 63.2.6概要設(shè)計(jì)格式 63.3軟件的詳細(xì)設(shè)計(jì) 73.3.1詳細(xì)設(shè)計(jì) 73.3.2特例 73.3.3詳細(xì)設(shè)計(jì)的要求 73.3.4數(shù)據(jù)庫(kù)設(shè)計(jì) 73.3.5詳細(xì)設(shè)計(jì)的評(píng)審 73.3.6詳細(xì)設(shè)計(jì)格式 83.4軟件的編碼 83.4.1軟件編碼 83.4.2軟件編碼的要求 83.4.3編碼的評(píng)審 83.4.4編程規(guī)范及要求 83.5軟件的測(cè)試 93.5.1軟件測(cè)試 93.5.2測(cè)試計(jì)劃 93.6軟件的交付準(zhǔn)備 93.6.1交付清單 93.7軟件的鑒定驗(yàn)收 103.7.1軟件的鑒定驗(yàn)收 103.7.2驗(yàn)收人員 103.7.3驗(yàn)收具體內(nèi)容 103.7.4軟件驗(yàn)收測(cè)試大綱 113.8培訓(xùn) 113.8.1系統(tǒng)應(yīng)用培訓(xùn) 113.8.2系統(tǒng)管理的培訓(xùn)（可選） 111.引言 191.1編寫(xiě)目的 191.2項(xiàng)目風(fēng)險(xiǎn) 191.3文檔約定 191.4預(yù)期讀者和閱讀建議 201.5產(chǎn)品范圍 201.6參考文獻(xiàn) 202.綜合描述 212.1產(chǎn)品的狀況 212.2產(chǎn)品的功能 222.3用戶類和特性 222.4運(yùn)行環(huán)境 222.5設(shè)計(jì)和實(shí)現(xiàn)上的限制 232.6假設(shè)和約束(依賴) 233.外部接口需求 243.1用戶界面 243.2硬件接口 253.3軟件接口 253.4通訊接口 264.系統(tǒng)功能需求 264.1說(shuō)明和優(yōu)先級(jí) 274.2激勵(lì)／響應(yīng)序列 274.3輸入／輸出數(shù)據(jù) 285.其它非功能需求 285.1性能需求 285.2安全措施需求 295.3安全性需求 295.4軟件質(zhì)量屬性 295.5業(yè)務(wù)規(guī)則 295.6用戶文檔 306.詞匯表 307.數(shù)據(jù)定義 308.分析模型 329.待定問(wèn)題列表 321.引言 391.1編寫(xiě)目的 391.2項(xiàng)目風(fēng)險(xiǎn) 391.3預(yù)期讀者和閱讀建議 391.4參考資料 402.設(shè)計(jì)概述 402.1限制和約束 412.2設(shè)計(jì)原則和設(shè)計(jì)要求 413.系統(tǒng)邏輯設(shè)計(jì) 413.1系統(tǒng)組織設(shè)計(jì) 423.2系統(tǒng)結(jié)構(gòu)設(shè)計(jì) 433.2.1系統(tǒng)特性表 433.2.2系統(tǒng)特性結(jié)構(gòu)圖 443.3系統(tǒng)接口設(shè)計(jì) 453.3.1系統(tǒng)接口表 453.3.2系統(tǒng)接口傳輸協(xié)議說(shuō)明 463.4系統(tǒng)完整性設(shè)計(jì) 474.系統(tǒng)出錯(cuò)處理設(shè)計(jì) 484.1系統(tǒng)出錯(cuò)處理表 484.2維護(hù)處理過(guò)程表 495.技術(shù)設(shè)計(jì) 515.1系統(tǒng)開(kāi)發(fā)技術(shù)說(shuō)明表 515.2開(kāi)發(fā)技術(shù)應(yīng)用說(shuō)明 526.數(shù)據(jù)庫(kù)設(shè)計(jì) 527.詞匯表 538.進(jìn)度計(jì)劃 531.引言 601.1編寫(xiě)目的 601.2項(xiàng)目風(fēng)險(xiǎn) 601.3文檔約定 601.4預(yù)期讀者和閱讀建議 611.5參考資料 612.支撐環(huán)境 622.1數(shù)據(jù)庫(kù)管理系統(tǒng) 622.2開(kāi)發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口 632.3硬件環(huán)境 642.4網(wǎng)絡(luò)環(huán)境 642.5多種支撐環(huán)境開(kāi)發(fā)要點(diǎn) 643.部件詳細(xì)設(shè)計(jì) 654.詞匯表 675.部件表格式 676.界面表格式 681.引言 771.1編寫(xiě)目的 771.2項(xiàng)目來(lái)源 771.3文檔約定 771.4預(yù)期讀者和閱讀建議 771.5參考資料 782.數(shù)據(jù)庫(kù)命名規(guī)則 793.數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明 793.1數(shù)據(jù)庫(kù)邏輯設(shè)計(jì) 793.2數(shù)據(jù)庫(kù)物理設(shè)計(jì) 793.3數(shù)據(jù)庫(kù)分布 793.4基表設(shè)計(jì) 803.5視圖設(shè)計(jì) 823.6索引設(shè)計(jì) 843.7完整性約束 853.8授權(quán)設(shè)計(jì) 853.9觸發(fā)器設(shè)計(jì) 863.10存儲(chǔ)過(guò)程設(shè)計(jì) 873.11數(shù)據(jù)復(fù)制設(shè)計(jì) 884.詞匯表 895.歷史數(shù)據(jù)處理 901.引言 981.1目的 981.2術(shù)語(yǔ) 981.3參照標(biāo)準(zhǔn) 982.測(cè)試日期安排 993.測(cè)試小組及成員 994.測(cè)試具體內(nèi)容 994.1合法性檢查 1004.2軟件文檔檢查 1004.2.1必須提供檢查的文檔 1004.2.2其他可能需要檢查的文檔 1004.2.3由業(yè)主確定必須檢查的其他文檔 1004.2.4文檔質(zhì)量的度量準(zhǔn)則 1014.3軟件代碼測(cè)試 1024.3.1源代碼一般性檢查 1024.3.2軟件一致性檢查 1024.4軟件系統(tǒng)測(cè)試 1034.4.1界面(外觀)測(cè)試 1034.4.2可用性測(cè)試 1044.4.3功能測(cè)試 1044.4.4穩(wěn)定性(強(qiáng)度)測(cè)試 1044.4.5性能測(cè)試 1044.4.6強(qiáng)壯性(恢復(fù))測(cè)試 1044.4.7邏輯性測(cè)試 1044.4.8破壞性測(cè)試 1054.4.9安全性測(cè)試 1055.測(cè)試結(jié)果交付方式 105

引言引言是對(duì)這份數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)的概覽，是為了幫助閱讀者了解這份文檔是如何編寫(xiě)的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。編寫(xiě)目的說(shuō)明這份數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)是為哪份軟件產(chǎn)品編寫(xiě)的，開(kāi)發(fā)這個(gè)軟件產(chǎn)品意義、作用以及最終要達(dá)到的意圖。通過(guò)這份數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)詳盡準(zhǔn)確地描述了該軟件產(chǎn)品的數(shù)據(jù)庫(kù)結(jié)構(gòu)。如果這份數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)中說(shuō)明的那個(gè)部分或子系統(tǒng)。項(xiàng)目來(lái)源具體說(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ā)者；產(chǎn)品使用者。文檔約定描述編寫(xiě)文檔時(shí)所采用的各種排版約定。排版約定應(yīng)該包括：命名方法；提示方式；通配符號(hào)：等等。預(yù)期讀者和閱讀建議列舉本數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)所針對(duì)的各種不同的預(yù)期讀者，例如，可能包括：開(kāi)發(fā)人員；項(xiàng)目經(jīng)理；測(cè)試人員；文檔編寫(xiě)人員。并且描述了文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合的文檔閱讀建議。參考資料列舉編寫(xiě)需求規(guī)格說(shuō)明書(shū)時(shí)所用到的參考文獻(xiàn)及資料，可能包括；本項(xiàng)目的合同書(shū)；上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文；本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書(shū)；用戶界面風(fēng)格指導(dǎo)；開(kāi)發(fā)本項(xiàng)目時(shí)所要用到的標(biāo)準(zhǔn)；系統(tǒng)規(guī)格需求說(shuō)明；使用實(shí)例文檔；屬于本項(xiàng)目的其它已發(fā)表文件；本數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)中所引用的文件、資料；相關(guān)軟件產(chǎn)品數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)；等等。為了方便讀者查閱，所有參考資料應(yīng)該按一定順序排列。如果可能，每份資料都應(yīng)該給出：標(biāo)題名稱；作者或者合同簽約者；文件編號(hào)或者版本號(hào)；發(fā)表日期或者簽約日期；出版單位或者資料來(lái)源。數(shù)據(jù)庫(kù)命名規(guī)則完整并且清楚的說(shuō)明本數(shù)據(jù)庫(kù)的命名規(guī)則，在《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》中已經(jīng)給出了一個(gè)完整的數(shù)據(jù)庫(kù)命名規(guī)則，開(kāi)發(fā)者應(yīng)遵守執(zhí)行，如果本數(shù)據(jù)庫(kù)的命名規(guī)則與該規(guī)范不完全一致，應(yīng)作出解釋。數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明數(shù)據(jù)庫(kù)邏輯設(shè)計(jì)數(shù)據(jù)庫(kù)設(shè)計(jì)人員根據(jù)《軟件需求分析報(bào)告》，創(chuàng)建與數(shù)據(jù)庫(kù)相關(guān)的實(shí)體關(guān)系圖(E-R圖)。如采用面對(duì)對(duì)象的分析和設(shè)計(jì)方法，則此處的實(shí)體相當(dāng)于類。在此處，應(yīng)給出邏輯設(shè)計(jì)的完整的E-R圖。數(shù)據(jù)庫(kù)物理設(shè)計(jì)在此處應(yīng)給出完整的數(shù)據(jù)庫(kù)物理結(jié)構(gòu)E-R圖。開(kāi)發(fā)者應(yīng)根據(jù)邏輯設(shè)計(jì)的結(jié)果，進(jìn)行數(shù)據(jù)庫(kù)的物理設(shè)計(jì)，并對(duì)表結(jié)構(gòu)進(jìn)行規(guī)范化處理(第一范式，第二范式，第三范式)。數(shù)據(jù)庫(kù)分布數(shù)據(jù)庫(kù)分布采用一張表格進(jìn)行描述，其格式如下：數(shù)據(jù)庫(kù)編號(hào)數(shù)據(jù)庫(kù)管理系統(tǒng)名稱數(shù)據(jù)庫(kù)管理系統(tǒng)版本號(hào)數(shù)據(jù)庫(kù)英文名稱數(shù)據(jù)庫(kù)中文名稱數(shù)據(jù)庫(kù)安裝物理位置其中：數(shù)據(jù)庫(kù)編號(hào)給出本系統(tǒng)中指定數(shù)據(jù)庫(kù)的順序編號(hào)。若本系統(tǒng)中只有一個(gè)數(shù)據(jù)庫(kù)，則本項(xiàng)內(nèi)容不需要描述，本表內(nèi)容也只有一行。說(shuō)明：在一個(gè)系統(tǒng)中可能安裝若干個(gè)相同的或者不同的數(shù)據(jù)庫(kù)管理系統(tǒng)，一個(gè)數(shù)據(jù)庫(kù)管理系統(tǒng)也可能安裝一個(gè)或者多個(gè)數(shù)據(jù)庫(kù)。數(shù)據(jù)庫(kù)管理系統(tǒng)名稱給出本系統(tǒng)中指定數(shù)據(jù)庫(kù)管理系統(tǒng)的商品名稱。若本系統(tǒng)中只有一種數(shù)據(jù)庫(kù)管理系統(tǒng)，則本項(xiàng)內(nèi)容不需要描述。數(shù)據(jù)庫(kù)管理系統(tǒng)版本號(hào)給出本系統(tǒng)中指定數(shù)據(jù)庫(kù)管理系統(tǒng)的版本號(hào)。若本系統(tǒng)中只有一個(gè)版本的數(shù)據(jù)庫(kù)管理系統(tǒng)，則本項(xiàng)內(nèi)容不需要描述。數(shù)據(jù)庫(kù)英文名稱給出本數(shù)據(jù)庫(kù)的英文名稱，該名稱是在應(yīng)用軟件中實(shí)際使用的名稱，必須符合《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》中相關(guān)命名規(guī)范。數(shù)據(jù)庫(kù)中文名稱給出本數(shù)據(jù)庫(kù)的中文名稱，該名稱是本數(shù)據(jù)庫(kù)英文名稱的說(shuō)明。數(shù)據(jù)庫(kù)安裝物理位置給出本數(shù)據(jù)庫(kù)安裝的實(shí)際位置，必須描述清楚該位置是在那個(gè)物理設(shè)備的哪一個(gè)邏輯存儲(chǔ)設(shè)備上，以及存儲(chǔ)文件的名稱?；碓O(shè)計(jì)每個(gè)基表采用一張表格進(jìn)行描述，其格式如下：數(shù)據(jù)庫(kù)編號(hào)：基表編號(hào)：基表英文名稱：基表中文名稱：字段編號(hào)英文字段名中文字段名字段類型備注說(shuō)明：其中數(shù)據(jù)庫(kù)編號(hào)含義同上。基表編號(hào)給出本基表的順序編號(hào)。基表英文名稱給出本基表的英文名稱，該名稱是在應(yīng)用軟件中實(shí)際使用的名稱，必須符合命名規(guī)范。基表中文名稱給出本基表的中文名稱，該名稱是本基表英文名稱的說(shuō)明。字段編號(hào)該基表中，各個(gè)字段的順序編號(hào)。英文字段名該基表中，各個(gè)字段的英文名稱，該名稱必須符合《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》中相關(guān)命名規(guī)范。中文字段名該基表中，各個(gè)字段的中文名稱，該名稱是英文字段名的說(shuō)明。字段類型該基表中，各個(gè)字段的類型；如果需要，在說(shuō)明類型時(shí)，還需要說(shuō)明字段長(zhǎng)度。備注該基表中，各個(gè)字段有關(guān)的限制性說(shuō)明，需要描述的內(nèi)容可能包括：值域；缺省值；空字段限制；顯示格式與小數(shù)位數(shù)；有效性規(guī)則與約束；標(biāo)題；等等說(shuō)明說(shuō)明一些有關(guān)本表的、必須描述清楚的問(wèn)題，需要描述的內(nèi)容可能包括：主關(guān)鍵字；索引、排序方式和類型；觸發(fā)器；數(shù)據(jù)復(fù)制；等等視圖設(shè)計(jì)每個(gè)視圖采用一張表格進(jìn)行描述，其格式如下：數(shù)據(jù)庫(kù)編號(hào)：視圖編號(hào)：視圖英文名稱：視圖中文名稱：相關(guān)基表和視圖：字段編號(hào)英文字段名中文字段名字段類型字段源備注說(shuō)明：其中：數(shù)據(jù)庫(kù)編號(hào)含義同上。視圖編號(hào)給出本視圖的順序編號(hào)。視圖英文名稱給出本視圖的英文名稱，該名稱是在應(yīng)用軟件中實(shí)際使用的名稱，必須符合命名規(guī)范。視圖中文名稱給出本視圖的中文名稱，該名稱是本視圖英文名稱的說(shuō)明。相關(guān)基表和視圖列出建立該視圖時(shí)，所用到的基表和視圖。字段編號(hào)該視圖中，各個(gè)字段的順序編號(hào)。英文字段名該視圖中，各個(gè)字段的英文名稱，該名稱必須符合《南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范》中相關(guān)命名規(guī)范。中文字段名該視圖中，各個(gè)字段的中文名稱，該名稱是英文字段名的說(shuō)明。字段類型該視圖中，各個(gè)字段的類型；如果需要，在說(shuō)明類型時(shí)，還需要說(shuō)明字段長(zhǎng)度。字段源該視圖中，各個(gè)字段的來(lái)源，即該字段原來(lái)是那個(gè)表或者那個(gè)視圖中的那個(gè)字段；在某些情況下，字段可能來(lái)自一個(gè)特定的表達(dá)式。備注該視圖中，各個(gè)字段有關(guān)的限制性說(shuō)明，包括：值域；缺省值；空字段限制；顯示格式與小數(shù)位數(shù)；有效性規(guī)則與約束；標(biāo)題；等等。說(shuō)明說(shuō)明一些有關(guān)本視圖的、必須描述清楚的問(wèn)題，需要描述的內(nèi)容可能包括：索引；權(quán)限；等等索引設(shè)計(jì)每個(gè)數(shù)據(jù)庫(kù)的所有采用一張表格進(jìn)行描述，其格式如下：數(shù)據(jù)庫(kù)編號(hào)：索引編號(hào)基表名稱索引名稱字段集名稱備注其中：數(shù)據(jù)庫(kù)編號(hào)含義同上。索引編號(hào)給出本項(xiàng)索引的順序編號(hào)。基表名稱給出本項(xiàng)索引所在的基表名稱。索引名稱給出本項(xiàng)索引的名稱。字段集名稱給出本項(xiàng)索引所在的字段名稱或者字段集名稱。備注描述有關(guān)本項(xiàng)索引中，其它需要說(shuō)明的事項(xiàng)，例如：排序方式、等等。完整性約束每個(gè)數(shù)據(jù)庫(kù)的完整性約束采用一張表格進(jìn)行描述，其格式如下：數(shù)據(jù)庫(kù)編號(hào)：索引編號(hào)基表名稱索引名稱字段集名稱