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

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

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