464520880數(shù)據(jù)庫(kù)課程設(shè)計(jì)模板需求分析+概要設(shè)計(jì)+詳細(xì)設(shè)計(jì)

1、附錄附錄 a 軟件需求分析報(bào)告文檔模板軟件需求分析報(bào)告文檔模板.1 附錄附錄 b 軟件概要軟件概要設(shè)設(shè)計(jì)報(bào)告文檔模板計(jì)報(bào)告文檔模板 .13 附錄附錄 c 軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板.33 附錄附錄 d 軟件數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告文檔模板軟件數(shù)據(jù)庫(kù)設(shè)計(jì)報(bào)告文檔模板.43 附錄附錄 e 軟件測(cè)試軟件測(cè)試(驗(yàn)收驗(yàn)收)大綱大綱.55 附錄附錄 a 軟件需求分析報(bào)告文檔模板軟件需求分析報(bào)告文檔模板 1. 引言引言 .11 1.1 編寫目的.11 1.2 項(xiàng)目風(fēng)險(xiǎn).11 1.3 文檔約定.11 1.4 預(yù)期讀者和閱讀建議.11 1.5 產(chǎn)品范圍.12 1.6 參考文獻(xiàn).12 2. 綜合描述綜

2、合描述 .12 2.1 產(chǎn)品的狀況.12 2.2 產(chǎn)品的功能.13 2.3 用戶類和特性.13 2.4 運(yùn)行環(huán)境.13 2.5 設(shè)計(jì)和實(shí)現(xiàn)上的限制.13 2.6 假設(shè)和約束(依賴).14 3. 外部接口需求外部接口需求 .14 3.1 用戶界面.14 3.2 硬件接口.15 3.3 軟件接口.15 3.4 通訊接口.16 4. 系統(tǒng)功能需求系統(tǒng)功能需求 .16 4.1 說(shuō)明和優(yōu)先級(jí).16 4.2 激勵(lì)響應(yīng)序列.17 4.3 輸入輸出數(shù)據(jù).17 5. 其它非功能需求其它非功能需求 .17 5.1 性能需求.17 5.2 安全措施需求.18 5.3 安全性需求.18 5.4 軟件質(zhì)量屬性.18 5

3、.5 業(yè)務(wù)規(guī)則.18 5.6 用戶文檔.18 6. 詞匯表詞匯表 .19 7. 數(shù)據(jù)定義數(shù)據(jù)定義 .19 8. 分析模型分析模型 .20 9. 待定問(wèn)題列表待定問(wèn)題列表 .20 1. 引言引言 引言是對(duì)這份軟件產(chǎn)品需求分析報(bào)告的概覽，是為了幫助閱讀者了解這份文檔是如何 編寫的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。 1.1 編寫目的編寫目的 說(shuō)明這份軟件產(chǎn)品需求分析報(bào)告是為哪個(gè)軟件產(chǎn)品編寫的，開發(fā)這個(gè)軟件產(chǎn)品意義、 作用、以及最終要達(dá)到的意圖。通過(guò)這份軟件產(chǎn)品需求分析報(bào)告詳盡說(shuō)明了該軟件產(chǎn)品的 需求規(guī)格，包括修正和(或)發(fā)行版本號(hào)，從而對(duì)該軟件產(chǎn)品進(jìn)行準(zhǔn)確的定義。 如果這份軟件產(chǎn)品需求分析報(bào)告

4、只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義軟件產(chǎn) 品需求分析報(bào)告中說(shuō)明的那個(gè)部分或子系統(tǒng)。 1.2 項(xiàng)目風(fēng)險(xiǎn)項(xiàng)目風(fēng)險(xiǎn) 具體說(shuō)明本軟件開發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng) 險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括： 任務(wù)提出者； 軟件開發(fā)者； 產(chǎn)品使用者。 1.3 文檔約定文檔約定 描述編寫文檔時(shí)所采用的標(biāo)準(zhǔn)(如果有標(biāo)準(zhǔn)的話)，或者各種排版約定。排版約定應(yīng)該 包括： 正文風(fēng)格； 提示方式； 重要符號(hào)； 也應(yīng)該說(shuō)明高層次需求是否可以被其所有細(xì)化的需求所繼承，或者每個(gè)需求陳述是否 都有其自己的優(yōu)先級(jí)。 1.4 預(yù)期讀者和閱讀建議預(yù)期讀者和閱讀建議 列舉本軟件產(chǎn)品需求分析報(bào)告所針對(duì)的各種不同的預(yù)期

5、讀者，例如，可能包括： 用戶； 開發(fā)人員； 項(xiàng)目經(jīng)理； 營(yíng)銷人員； 測(cè)試人員； 文檔編寫入員。 并且描述了文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合 的文檔閱讀建議。 1.5 產(chǎn)品范圍產(chǎn)品范圍 說(shuō)明該軟件產(chǎn)品及其開發(fā)目的的簡(jiǎn)短描述，包括利益和目標(biāo)。把軟件產(chǎn)品開發(fā)與企業(yè) 目標(biāo)，或者業(yè)務(wù)策略相聯(lián)系。 描述產(chǎn)品范圍時(shí)需注意，可以參考項(xiàng)目視圖和范圍文檔，但是不能將其內(nèi)容復(fù)制到這 里。 1.6 參考文獻(xiàn)參考文獻(xiàn) 列舉編寫軟件產(chǎn)品需求分析報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括： 本項(xiàng)目的合同書； 上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文； 本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書； 用戶界面風(fēng)格指導(dǎo)； 開發(fā)本項(xiàng)目

6、時(shí)所要用到的標(biāo)淮； 系統(tǒng)規(guī)格需求說(shuō)明； 使用實(shí)例文檔； 屬于本項(xiàng)目的其它己發(fā)表文件； 本軟件產(chǎn)品需求分析報(bào)告中所引用的文件、資料； 相關(guān)軟件產(chǎn)品需求分析報(bào)告； 為了方便讀者查閱，所有參考資料應(yīng)該按一定順序排列。如果可能，每份資料都應(yīng)該 給出： 標(biāo)題名稱； 作者或者合同簽約者； 文件編號(hào)或者版本號(hào)； 發(fā)表日期或者簽約日期； 出版單位或者資料來(lái)源。 2. 綜合描述綜合描述 這一部分概述了正在定義的軟件產(chǎn)品的作用范圍以及該軟件產(chǎn)品所運(yùn)行的環(huán)境、使用 該軟件產(chǎn)品的用戶、對(duì)該軟件產(chǎn)品己知的限制、有關(guān)該軟件產(chǎn)品的假設(shè)和依賴。 2.1 產(chǎn)品的狀況產(chǎn)品的狀況 描述了在軟件產(chǎn)品需求分析報(bào)告中所定義的軟件產(chǎn)品的背

7、景和起源。說(shuō)明了該軟件產(chǎn) 品是否屬于下列情況： 是否是產(chǎn)品系列中的下一成員； 是否是成熟產(chǎn)品所改進(jìn)的下一代產(chǎn)品； 是否是現(xiàn)有應(yīng)用軟件的替代品(升級(jí)產(chǎn)品)； 是否是一個(gè)新型的、自主型的產(chǎn)品。 如果該軟件產(chǎn)品需求分析報(bào)告定義的軟件系統(tǒng)是： 大系統(tǒng)的一個(gè)組成部分； 與其它系統(tǒng)和其它機(jī)構(gòu)之間存在基本的相互關(guān)系。 那么必須說(shuō)明軟件產(chǎn)品需求分析報(bào)告定義的這部分軟件是怎樣與整個(gè)大系統(tǒng)相關(guān)聯(lián)的， 或者（同時(shí)）說(shuō)明相互關(guān)系的存在形式，并且要定義出兩者之間的全部接口。 2.2 產(chǎn)品的功能產(chǎn)品的功能 因?yàn)閷⒃谛枨蠓治鰣?bào)告的第 4 部分中詳細(xì)描述軟件產(chǎn)品的功能，所以在此只需要概略 地總結(jié)。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所

8、應(yīng)具有的主要功能，在描述功能時(shí)應(yīng)該針對(duì)每一 項(xiàng)需求準(zhǔn)確地描述其各項(xiàng)規(guī)格說(shuō)明。如果存在引起誤解的可能，在陳述本軟件產(chǎn)品主要功 能的作用領(lǐng)域時(shí)，也需要對(duì)應(yīng)陳述本軟件產(chǎn)品的非作用領(lǐng)域，以利讀者理解本軟件產(chǎn)品。 為了很好地組織產(chǎn)品功能，使每個(gè)讀者都容易理解，可以采用列表的方法給出。也可 以采用圖形方式，將主要的需求分組以及它們之間的聯(lián)系使用數(shù)據(jù)流程圖的頂層圖或類圖 進(jìn)行表示，這種表示方法是很有用的。 參考用戶當(dāng)前管理組織構(gòu)架，了解各個(gè)機(jī)構(gòu)的主要職能，將有助于陳述軟件產(chǎn)品的主 要功能。 2.3 用戶類和特性用戶類和特性 確定有可能使用該軟件產(chǎn)品的不同用戶類，并且描述它們相關(guān)的特征。往往有一些軟 件需求，

9、只與特定的用戶類有關(guān)。描述時(shí)，應(yīng)該將該軟件產(chǎn)品的重要用戶類與非重要用戶 類區(qū)分開。 用戶不一定是軟件產(chǎn)品的直接使用者，通過(guò)報(bào)表、應(yīng)用程序接口、系統(tǒng)硬件接口得到 軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人、或者機(jī)構(gòu)也有他們的需求。所以，應(yīng)該將這些外部需求視為 通過(guò)報(bào)表、應(yīng)用程序接口、系統(tǒng)硬件接口附加給軟件產(chǎn)品的附加用戶類。 2.4 運(yùn)行環(huán)境運(yùn)行環(huán)境 描述了本軟件的運(yùn)行環(huán)境，一般包括： 硬件平臺(tái)； 操作系統(tǒng)和版本； 支撐環(huán)境(例如：數(shù)據(jù)庫(kù)等)和版本； 其它與該軟件有關(guān)的軟件組件； 與該軟件共存的應(yīng)用程序。 2.5 設(shè)計(jì)和實(shí)現(xiàn)上的限制設(shè)計(jì)和實(shí)現(xiàn)上的限制 確定影響開發(fā)人員自由選擇的問(wèn)題，并且說(shuō)明這些問(wèn)題為什么成為一種限

10、制?？赡艿?限制包括下列內(nèi)容： 必須使用的特定技術(shù)、工具、編程語(yǔ)言和數(shù)據(jù)庫(kù)； 避免使用的特定技術(shù)、工具、編程語(yǔ)言和數(shù)據(jù)庫(kù)； 要求遵循的開發(fā)規(guī)范和標(biāo)準(zhǔn) 例如，如果由客戶的公司或者第三方公司負(fù)責(zé)軟件維護(hù)，就必須定義轉(zhuǎn)包者所使用的 設(shè)計(jì)符號(hào)表示和編碼標(biāo)準(zhǔn)； 企業(yè)策略的限制； 政府法規(guī)的限制； 工業(yè)標(biāo)準(zhǔn)的限制； 硬件的限制 例如，定時(shí)需求或存儲(chǔ)器限制； 數(shù)據(jù)轉(zhuǎn)換格式標(biāo)淮的限制。 2.6 假設(shè)和約束假設(shè)和約束(依賴依賴) 列舉出對(duì)軟件產(chǎn)品需求分析報(bào)告中，影響需求陳述的假設(shè)因素(與己知因素相對(duì)立)。 如果這些假設(shè)因素不正確、不一致或者被修改，就會(huì)使軟件產(chǎn)品開發(fā)項(xiàng)目受到影響。這些 假設(shè)的因素可能包括： 計(jì)劃

11、使用的商業(yè)組件，或者其它軟件中的某個(gè)部件； 假定產(chǎn)品中某個(gè)用戶界面將符合一個(gè)特殊的設(shè)計(jì)約定； 有關(guān)本軟件用戶的若干假定(例如：假定用戶會(huì)熟練使用 sql 語(yǔ)言。)； 有關(guān)本軟件開發(fā)工作的若干假定(例如：用戶承諾的優(yōu)惠、方便、上級(jí)部門給予的 特殊政策和支持等。)； 有關(guān)本軟件運(yùn)行環(huán)境的一些問(wèn)題； 此外，確定本軟件開發(fā)項(xiàng)目對(duì)外部約束因素所存在的依賴。有關(guān)的約束可能包括： 工期約束； 經(jīng)費(fèi)約束； 人員約束； 設(shè)備約束； 地理位置約束； 其它有關(guān)項(xiàng)目約束； 3. 外部接口需求外部接口需求 通過(guò)本節(jié)描述可以確定，保證軟件產(chǎn)品能和外部組件正確連接的需求。關(guān)聯(lián)圖僅能表 示高層抽象的外部接口，必須對(duì)接口數(shù)據(jù)和

12、外部組件進(jìn)行詳細(xì)描述，并且寫入數(shù)據(jù)定義中。 如果產(chǎn)品的不同部分有不同的外部接口，那么應(yīng)該把這些外部接口的全部詳細(xì)需求并入到 這一部分實(shí)例中。 注意：必須將附加用戶類的特征與外部接口需求加以區(qū)分，附加用戶類的特征描述的 是通過(guò)接口取得軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人的需求；而外部接口需求描述的是接口本身的 需求。 3.1 用戶界面用戶界面 陳述需要使用在用戶界面上的軟件組件，描述每一個(gè)用戶界面的邏輯特征。必須注意， 這里需要描述的是用戶界面的邏輯特征，而不是用戶界面。以下是可能包括的一些特征： 將要采用的圖形用戶界面(gul)標(biāo)準(zhǔn)或者產(chǎn)品系列的風(fēng)格； 有關(guān)屏幕布局或者解決方案的限制； 將要使用在每一個(gè)屏

13、幕(圖形用戶界面)上的軟件組件，可能包括： 選單； 標(biāo)準(zhǔn)按鈕； 導(dǎo)航鏈接； 各種功能組件； 消息欄； 快捷鍵； 各種顯示格式的規(guī)定，可能包括： 不同情況下文字的對(duì)齊方式； 不同情況下數(shù)字的表現(xiàn)格式與對(duì)齊方式 日期的表現(xiàn)方法與格式； 計(jì)時(shí)方法與時(shí)間格式； 等等。 錯(cuò)誤信息顯示標(biāo)準(zhǔn)； 對(duì)于用戶界面的細(xì)節(jié)，例如：一個(gè)特定對(duì)話框的布局，應(yīng)該寫入具體的用戶界面設(shè)計(jì) 說(shuō)明中，而不能寫入軟件需求規(guī)格說(shuō)明中。 如果采用現(xiàn)成的、合適的用戶界面設(shè)計(jì)規(guī)范(標(biāo)準(zhǔn))，或者另文描述，可以在這里直接 說(shuō)明，并且將其加入?yún)⒖嘉墨I(xiàn)。 3.2 硬件接口硬件接口 描述待開發(fā)的軟件產(chǎn)品與系統(tǒng)硬件接口的特征，若有多個(gè)硬件接口，則必須全

14、都描述。 接口特征的描述內(nèi)容可能包括： 支持的硬件類型； 軟、硬件之間交流的數(shù)據(jù)； 控制信息的性質(zhì)； 使用的通訊協(xié)議； 3.3 軟件接口軟件接口 描述該軟件產(chǎn)品與其它外部組件的連接，這些外部組件必須明確它們的名稱和版本號(hào) 以資識(shí)別，可能的外部組件包括： 操作系統(tǒng)； 數(shù)據(jù)庫(kù)； 工具； 函數(shù)庫(kù)； 集成的商業(yè)組件 說(shuō)明：這里所說(shuō)的“集成的商業(yè)組件” ，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產(chǎn) 品集成的商業(yè)組件。例如：中間件、消息服務(wù)，等等。 描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。描述所需要的服務(wù)， 以及與內(nèi)部組件通訊的性質(zhì)。確定軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。如果必須使用一種 特

15、殊的方法來(lái)實(shí)現(xiàn)數(shù)據(jù)共享機(jī)制，例如：在多用戶系統(tǒng)中的一個(gè)全局?jǐn)?shù)據(jù)區(qū)，那么就必須 把它定義為一種實(shí)現(xiàn)上的限制。 3.4 通訊接口通訊接口 描述與軟件產(chǎn)品所使用的通訊功能相關(guān)的需求，包括： 電子郵件； web 瀏覽器； 網(wǎng)絡(luò)通訊標(biāo)準(zhǔn)或者協(xié)議； 數(shù)據(jù)交互用電子表格； 必須定義相關(guān)的： 消息格式； 通訊安全或加密問(wèn)題； 數(shù)據(jù)傳輸速率； 同步和異步通訊機(jī)制； 4. 系統(tǒng)功能需求系統(tǒng)功能需求 需要進(jìn)行詳細(xì)的需求記錄，詳細(xì)列出與該系統(tǒng)功能相關(guān)的詳細(xì)功能需求，并且，唯一 地標(biāo)識(shí)每一項(xiàng)需求。這是必須提交給用戶的軟件功能，使得用戶可以使用所提供的功能執(zhí) 行服務(wù)或者使用所指定的使用實(shí)例執(zhí)行任務(wù)。描述軟件產(chǎn)品如何響應(yīng)己

16、知的出錯(cuò)條件、非 法輸入、非法動(dòng)作。 如果每一項(xiàng)功能需求都能用一項(xiàng)，也只需要用一項(xiàng)測(cè)試用例就能進(jìn)行驗(yàn)證，那么就可 以認(rèn)為功能需求已經(jīng)適當(dāng)?shù)剡M(jìn)行描述了。如果某項(xiàng)功能需求找不到合適的測(cè)試用例，或者 必須使用多項(xiàng)測(cè)試用例才能驗(yàn)證，那么該項(xiàng)功能需求的描述必然存在某些問(wèn)題。 功能需求是根據(jù)系統(tǒng)功能，即軟件產(chǎn)品所提供的主要服務(wù)來(lái)組織的?？梢酝ㄟ^(guò)使用實(shí) 例、運(yùn)行模式、用戶類、對(duì)象類或者功能等級(jí)來(lái)組織這部分內(nèi)容，也可以便用這些元素的 組合?？偠灾?，必須選擇一種是讀者容易理解預(yù)期產(chǎn)品的組織方案。 用簡(jiǎn)短的語(yǔ)句說(shuō)明功能的名稱，例如：“4.1 系統(tǒng)參數(shù)管理” 。按照服務(wù)組織的順序， 逐條闡述系統(tǒng)功能。無(wú)論說(shuō)明的是

17、何種功能，都應(yīng)該針對(duì)該系統(tǒng)功能重復(fù)敘述 4.1 4.3 這 三個(gè)部分。 可以通過(guò)各種方式來(lái)組織這一部分內(nèi)容，例如采用：使用實(shí)例、運(yùn)行模式、用戶類、 對(duì)象類、功能等級(jí)等，也可以采用它們的組合。其最終目的是，讓讀者容易理解即將開發(fā) 的軟件產(chǎn)品。一般來(lái)說(shuō)，每個(gè)使用實(shí)例都對(duì)應(yīng)一個(gè)系統(tǒng)功能，因而按照使用實(shí)例來(lái)組織內(nèi) 容比較容易讓用戶理解。 對(duì)應(yīng)一些被共享的獨(dú)立使用實(shí)例，可以定義一些公用系統(tǒng)功能。 必須特別注意的是，在 2.2 節(jié)“產(chǎn)品的功能”中描述的全部需求，以及它們的規(guī)格說(shuō) 明；必須在某個(gè)系統(tǒng)功能描述中有所反映，而且不應(yīng)重復(fù)。 4.1 說(shuō)明和優(yōu)先級(jí)說(shuō)明和優(yōu)先級(jí) 對(duì)該系統(tǒng)功能進(jìn)行簡(jiǎn)短的說(shuō)明，并且指出該系

18、統(tǒng)功能的優(yōu)先級(jí)是：高、中、還是低。 需要的話，還可以包括對(duì)特定優(yōu)先級(jí)部分的評(píng)價(jià)，例如：利益、損失、費(fèi)用和風(fēng)險(xiǎn)，其相 對(duì)優(yōu)先等級(jí)可以從 1(低)到 9(高)。 4.2 激勵(lì)響應(yīng)序列激勵(lì)響應(yīng)序列 列出輸入激勵(lì)(用戶動(dòng)作、來(lái)自外部設(shè)備的信號(hào)或者其它觸發(fā))并且定義針對(duì)這功 能行為的系統(tǒng)響應(yīng)序列，這些序列將與使用實(shí)例中相關(guān)的對(duì)話元素相對(duì)應(yīng)。 描述激勵(lì)響應(yīng)序列時(shí)，不僅需要描述基本過(guò)程，而且應(yīng)該描述可選(擴(kuò)充)過(guò)程，包 括例外(引起任務(wù)不能順序完成的情況稱為例外)。疏忽了可選過(guò)程，有可能影響軟件產(chǎn)品 的功能；如果遺漏例外過(guò)程，則有可能會(huì)引發(fā)系統(tǒng)崩潰。 如果采用流程圖來(lái)描述激勵(lì)響應(yīng)序列，比較容易讓用戶理解。

19、4.3 輸入輸出數(shù)據(jù)輸入輸出數(shù)據(jù) 列出輸入數(shù)據(jù)(用戶輸入、來(lái)自外部接口的輸入或者其它輸入)并且定義針對(duì)這些輸入 數(shù)據(jù)的處理(計(jì)算)方法，以及相應(yīng)地輸出數(shù)據(jù)，描述對(duì)應(yīng)區(qū)別：輸入數(shù)據(jù)和輸出數(shù)據(jù)。 當(dāng)有大量數(shù)據(jù)需要描述時(shí)，也可以分類描述數(shù)據(jù)，并且注明各項(xiàng)數(shù)據(jù)的輸入、輸出屬 性。 對(duì)于每一項(xiàng)數(shù)據(jù)，均需要描述： 數(shù)據(jù)名稱； 實(shí)際含義； 數(shù)據(jù)類型； 數(shù)據(jù)格式； 數(shù)據(jù)約束； 對(duì)于復(fù)雜的處理方法，僅僅給出算法原理是不夠的，必須描述詳細(xì)的計(jì)算過(guò)程，并且 列出每一步具體使用的實(shí)際算式；如果計(jì)算過(guò)程中涉及查表、判斷、迭代等處理方法，應(yīng) 該給出處理依據(jù)和相關(guān)數(shù)據(jù)。如果計(jì)算方法很簡(jiǎn)單，也可以將其從略，不加描述。 5.

20、其它非功能需求其它非功能需求 在這里列舉出所有非功能需求，主要包括可靠性、安全性、可維護(hù)性、可擴(kuò)展性、可 測(cè)試性等。 5.1 性能需求性能需求 闡述不同應(yīng)用領(lǐng)域?qū)浖a(chǎn)品性能的需求，并且說(shuō)明提出需求的原理或者依據(jù)，以幫 助開發(fā)人員做出合理的設(shè)計(jì)選擇。盡可能詳細(xì)地描述性能需求，如果需要，可以針對(duì)每個(gè) 功能需求或者特征分別陳述其性能需求。在這里確定： 相互合作的用戶數(shù)量； 系統(tǒng)支持的并發(fā)操作數(shù)量； 響應(yīng)時(shí)間； 與實(shí)時(shí)系統(tǒng)的時(shí)間關(guān)系： 容量需求 存儲(chǔ)器； 磁盤空間； 數(shù)據(jù)庫(kù)中表的最大行數(shù)。 5.2 安全措施需求安全措施需求 詳盡陳述與軟件產(chǎn)品使用過(guò)程中可能發(fā)生的損失、破壞、危害相關(guān)的需求。定義必須

21、采取的安全保護(hù)或動(dòng)作，以及必須預(yù)防的潛在危險(xiǎn)動(dòng)作。明確軟件產(chǎn)品必須遵從的安全標(biāo) 準(zhǔn)、策略、或規(guī)則。 5.3 安全性需求安全性需求 詳盡陳述與系統(tǒng)安全性、完整性問(wèn)題相關(guān)的需求，或者與個(gè)人隱私問(wèn)題相關(guān)的需求。 這些問(wèn)題將會(huì)影響到軟件產(chǎn)品的使用，和軟件產(chǎn)品所創(chuàng)建或者使用的數(shù)據(jù)的保護(hù)。定義用 戶身份認(rèn)證，或備授權(quán)需求。明確軟件產(chǎn)品必須滿足的安全性或者保密性策略。也可以通 過(guò)稱為完整性的質(zhì)量屬性來(lái)闡述這些需求。一個(gè)典型的軟件系統(tǒng)安全需求范例如下：“每 個(gè)用戶在第一次登錄后，必須更改他的系統(tǒng)預(yù)置登錄密碼，系統(tǒng)預(yù)置的登錄密碼不能重用。 ” 5.4 軟件質(zhì)量屬性軟件質(zhì)量屬性 詳盡陳述對(duì)客戶和開發(fā)人員至關(guān)重要的

22、在軟件產(chǎn)品其它方面表現(xiàn)出來(lái)的質(zhì)量功能。這 些功能必須是確定的、定量的、在需要時(shí)是可以驗(yàn)證的。至少也應(yīng)該指明不同屬性的相對(duì) 側(cè)重點(diǎn)，例如：易用性優(yōu)于易學(xué)性，或者可移植性優(yōu)于有效性。 5.5 業(yè)務(wù)規(guī)則業(yè)務(wù)規(guī)則 列舉出有關(guān)軟件產(chǎn)品的所有操作規(guī)則，例如：那些人在特定環(huán)境下可以進(jìn)行何種操作。 這些本身不是功能需求，但是他們可以暗示某些功能需求執(zhí)行這些規(guī)則。一個(gè)業(yè)務(wù)規(guī)則的 范例如下：“進(jìn)行達(dá)到或者超過(guò) 10，000，00 元人民幣的儲(chǔ)蓄業(yè)務(wù)時(shí)，必須通過(guò)附加的管 理員認(rèn)證。 ” 列舉業(yè)務(wù)規(guī)則時(shí)，可以根據(jù)規(guī)則的數(shù)量，選取合適的編目方式。 5.6 用戶文檔用戶文檔 列舉出將與軟件產(chǎn)品一同交付的用戶文檔，并且明確

23、所有己知用戶文檔的交付格式或 標(biāo)準(zhǔn)，例如： 安裝指南 紙質(zhì)文檔，16 開本； 用戶手冊(cè) 紙質(zhì)文檔，16 開本； 在線幫助 電子文檔，與軟件產(chǎn)品一同分發(fā)、配置； 使用教程電子文檔，與軟件產(chǎn)品一同分發(fā)、配置。 6. 詞匯表詞匯表 列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫的定義(如有可能，列出相關(guān)的外 文原詞)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士閱讀軟件產(chǎn)品需求分析報(bào)告，要求使 用非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)的術(shù)語(yǔ)描述軟件需求。所以這里所指的專業(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)確

24、定義。 7. 數(shù)據(jù)定義數(shù)據(jù)定義 數(shù)據(jù)定義是一個(gè)定義了應(yīng)用程序中使用的所有數(shù)據(jù)元素和結(jié)構(gòu)的共享文檔，其中對(duì)每 個(gè)數(shù)據(jù)元素和結(jié)構(gòu)都準(zhǔn)確描述：含義、類型、數(shù)據(jù)大小、格式、計(jì)量單位、精度以及取值 范圍。數(shù)據(jù)定義的維護(hù)獨(dú)立于軟件需求規(guī)格說(shuō)明，并且在軟件產(chǎn)品開發(fā)和維護(hù)的任何階段， 均向風(fēng)險(xiǎn)承擔(dān)者開放。 如果為軟件開發(fā)項(xiàng)目創(chuàng)建一個(gè)獨(dú)立的數(shù)據(jù)定義，而不是為每一項(xiàng)特性描述有關(guān)的數(shù)據(jù) 項(xiàng)，有利于避免冗余和不一致性。但是卻不利于多人協(xié)同編寫需求分析報(bào)告，容易遺漏數(shù) 據(jù)，也不方便閱讀。因此還是建議為每個(gè)特性描述有關(guān)的數(shù)據(jù)項(xiàng)，匯總數(shù)據(jù)項(xiàng)創(chuàng)建數(shù)據(jù)定 義，再根據(jù)數(shù)據(jù)定義復(fù)核全部數(shù)據(jù)，使得它們的名稱和含義完全一致。必須注意的

25、是，為 了避免二義性，在匯總數(shù)據(jù)項(xiàng)時(shí)應(yīng)該根據(jù)數(shù)據(jù)項(xiàng)所代表的實(shí)際意義匯總，而不是根據(jù)數(shù)據(jù) 項(xiàng)的名稱匯總。 在數(shù)據(jù)定義中，每個(gè)數(shù)據(jù)項(xiàng)除了有一個(gè)中文名稱外，還應(yīng)該為它取一個(gè)簡(jiǎn)短的英文名 稱，該英文名稱應(yīng)該符合命名規(guī)范，因?yàn)樵谲浖_發(fā)時(shí)將沿用該英文名稱。可以使用等號(hào) 表示數(shù)據(jù)項(xiàng)，名稱寫在左邊，定義寫在右邊。常見數(shù)據(jù)項(xiàng)的描述方式如下： 原數(shù)據(jù)元素 一個(gè)原數(shù)據(jù)元素是不可分解的，可以將一個(gè)數(shù)量值賦給它。定義原數(shù)據(jù)元素必須確定 其 含義、類型、數(shù)據(jù)大小、格式、計(jì)量單位、精度以及取值范圍。采用以星號(hào)為界的一 行 注釋文本，描述原數(shù)據(jù)元素的定義。 選擇項(xiàng) 選擇項(xiàng)是一種只可以取有限離散值的特殊原數(shù)據(jù)元素，描述時(shí)一一

26、枚舉這些值，并用 方 括號(hào)括起來(lái)寫在原數(shù)據(jù)元素的定義前。在兩項(xiàng)離散值之間，使用管道符分隔。 組合項(xiàng) 組合項(xiàng)是一個(gè)數(shù)據(jù)結(jié)構(gòu)或者記錄，其中包含了多個(gè)數(shù)據(jù)項(xiàng)。這些數(shù)據(jù)項(xiàng)可以是原數(shù)據(jù) 元 素，也可以是組合數(shù)據(jù)項(xiàng)，各數(shù)據(jù)項(xiàng)之間用加號(hào)連接。其中每個(gè)數(shù)據(jù)項(xiàng)都必須是數(shù)據(jù) 定 義中定義過(guò)的，結(jié)構(gòu)中也可以包括其它結(jié)構(gòu)，但是絕對(duì)不允許遞歸。如果數(shù)據(jù)結(jié)構(gòu)中 有 可選項(xiàng)，使用圓括號(hào)把該項(xiàng)括起來(lái)。 重復(fù)項(xiàng) 重復(fù)項(xiàng)是組合項(xiàng)的一種特例，其中有一項(xiàng)將有多個(gè)實(shí)例出現(xiàn)在數(shù)據(jù)結(jié)構(gòu)中，使用花括 號(hào) 把該項(xiàng)括起來(lái)。如果知道該項(xiàng)可能允許的范圍，就按“最小值：最大值”的形式寫在 花 括號(hào)前。 8. 分析模型分析模型 這是一個(gè)可選部分，包括或

27、涉及到相關(guān)的分析模型，例如： 數(shù)據(jù)流程圖； 類圖； 狀態(tài)轉(zhuǎn)換圖； 實(shí)體-關(guān)系圖。 9. 待定問(wèn)題列表待定問(wèn)題列表 編輯一張?jiān)谲浖a(chǎn)品需求分析報(bào)告中待確定問(wèn)題時(shí)的列表，把每一個(gè)表項(xiàng)都編上號(hào)， 以便跟蹤調(diào)查。 附錄附錄 b 軟件概要設(shè)計(jì)報(bào)告文檔模板軟件概要設(shè)計(jì)報(bào)告文檔模板 1. 引言引言 .23 1.1 編寫目的.23 1.2 項(xiàng)目風(fēng)險(xiǎn).23 1.3 預(yù)期讀者和閱讀建議.23 1.4 參考資料.23 2. 設(shè)計(jì)概述設(shè)計(jì)概述 .24 2.1 限制和約束.24 2.2 設(shè)計(jì)原則和設(shè)計(jì)要求.24 3. 系統(tǒng)邏輯設(shè)計(jì)系統(tǒng)邏輯設(shè)計(jì) .25 3.1 系統(tǒng)組織設(shè)計(jì).25 3.2 系統(tǒng)結(jié)構(gòu)設(shè)計(jì).25 3.2.1

28、系統(tǒng)特性表.26 3.2.2 系統(tǒng)特性結(jié)構(gòu)圖.27 3.3 系統(tǒng)接口設(shè)計(jì).27 3.3.1 系統(tǒng)接口表.27 3.3.2 系統(tǒng)接口傳輸協(xié)議說(shuō)明.28 3.4 系統(tǒng)完整性設(shè)計(jì).28 4. 系統(tǒng)出錯(cuò)處理設(shè)計(jì)系統(tǒng)出錯(cuò)處理設(shè)計(jì) .29 4.1 系統(tǒng)出錯(cuò)處理表.29 4.2 維護(hù)處理過(guò)程表.30 5. 技術(shù)設(shè)計(jì)技術(shù)設(shè)計(jì) .31 5.1 系統(tǒng)開發(fā)技術(shù)說(shuō)明表.31 5.2 開發(fā)技術(shù)應(yīng)用說(shuō)明.32 6. 數(shù)據(jù)庫(kù)設(shè)計(jì)數(shù)據(jù)庫(kù)設(shè)計(jì) .32 7. 詞匯表詞匯表 .32 8. 進(jìn)度計(jì)劃進(jìn)度計(jì)劃 .32 1. 引言引言 引言是對(duì)這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔是如何 編寫的，并且應(yīng)該如何閱讀、

29、理解和解釋這份文檔。 1.1 編寫目的編寫目的 說(shuō)明這份軟件系統(tǒng)概要設(shè)計(jì)報(bào)告是基于哪份軟件產(chǎn)品需求規(guī)格說(shuō)明書編寫的，開發(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)。 1.2 項(xiàng)目風(fēng)險(xiǎn)項(xiàng)目風(fēng)險(xiǎn) 具體說(shuō)明本軟件開發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng) 險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括： 任務(wù)提出者； 軟件開發(fā)者； 產(chǎn)品使用者。 1.3 預(yù)期讀者和閱讀

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

31、相關(guān)軟件系統(tǒng)概要設(shè)計(jì)報(bào)告： 等等。 為了方便讀者查閱，所有參考資料應(yīng)該按一定順排列。如果可能，每份資料都應(yīng)該給 出： 標(biāo)題名稱； 作者或者合同簽約者； 文件編號(hào)或者版本號(hào)； 發(fā)表日期或者簽約日期； 出版單位或者資料來(lái)源。 2. 設(shè)計(jì)概述設(shè)計(jì)概述 本節(jié)描述現(xiàn)有開發(fā)條件和需要實(shí)現(xiàn)的目標(biāo)，說(shuō)明進(jìn)行概要設(shè)計(jì)時(shí)應(yīng)該遵循的設(shè)計(jì)原則 和必須采用的設(shè)計(jì)方法。 2.1 限制和約束限制和約束 簡(jiǎn)要描述起到限制和約束作用的各種可能存在的條件，例如： 技術(shù)條件； 資金狀況； 開發(fā)環(huán)境(包括：工具和平臺(tái))； 時(shí)間限制； 等等。 并且說(shuō)明在上述條件下，應(yīng)該實(shí)現(xiàn)的系統(tǒng)目標(biāo)， 2.2 設(shè)計(jì)原則和設(shè)計(jì)要求設(shè)計(jì)原則和設(shè)計(jì)要求 描

32、述對(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ù)性要求； 等等。 3. 系統(tǒng)邏輯設(shè)計(jì)系統(tǒng)邏輯設(shè)計(jì) 本節(jié)內(nèi)容主要根據(jù)軟件產(chǎn)品需求規(guī)格說(shuō)明書和軟件產(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)開發(fā)技術(shù)說(shuō)明。 說(shuō)明：如果進(jìn)行系統(tǒng)設(shè)計(jì)時(shí)尚未編寫軟件數(shù)據(jù)字典：應(yīng)首先參照附錄 b

33、說(shuō)明，編寫軟 件數(shù)據(jù)字典。在完成軟件數(shù)據(jù)字典后，再進(jìn)行系統(tǒng)設(shè)計(jì)。 3.1 系統(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è) 置

34、，實(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í)際安裝的部門、或者某個(gè)具體地點(diǎn)。 備注 針對(duì)該子系統(tǒng)，需要說(shuō)明的其它有關(guān)問(wèn)題。 3.2 系統(tǒng)結(jié)構(gòu)設(shè)計(jì)系統(tǒng)結(jié)

35、構(gòu)設(shè)計(jì) 本節(jié)將對(duì)系統(tǒng)特性作較為詳細(xì)的描述，并給出系統(tǒng)特性結(jié)構(gòu)圖。 3.2.1 系統(tǒng)特性表 系統(tǒng)特性是系統(tǒng)中完成某項(xiàng)具體操作的基本單元，它由入口參數(shù)，出口參數(shù)以及處理 過(guò)程三部分組成。 系統(tǒng)特性可以具有操作界面，也可以沒有操作界面；可以被其它操作界面、或者系統(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ì)

36、象 備注 說(shuō)明： 其中 子系統(tǒng)編號(hào) 含義同上。 子系統(tǒng)英文名稱 含義同上。 子系統(tǒng)中文名稱 含義同上。 特性編號(hào) 整個(gè)系統(tǒng)所有特性的統(tǒng)一編號(hào)。 系統(tǒng)特性英文名稱 系統(tǒng)特性的英文正式名稱，將來(lái)用于軟件開發(fā)中，必須符合命名規(guī)范。 系統(tǒng)特性中文名稱 系統(tǒng)特性的中文正式名稱，來(lái)源于需求規(guī)格說(shuō)明書中，系統(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ì)

37、象。 備注 描述與該系統(tǒng)特性有關(guān)的其它注意事項(xiàng)。 說(shuō)明 描述與該系統(tǒng)特性表有關(guān)的其它注意事項(xiàng)。 3.2.2 系統(tǒng)特性結(jié)構(gòu)圖 系統(tǒng)特性結(jié)構(gòu)圖給出系統(tǒng)特性在邏輯層面上相互之間的關(guān)系，其主要依據(jù)來(lái)源于需求 規(guī)格說(shuō)明書中，系統(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)特性，如果確有必要，盡可能只 畫出第一層系統(tǒng)特性。繪制子系統(tǒng)與系統(tǒng)特性結(jié)構(gòu)圖時(shí)，通常也不需要描繪出第二層系統(tǒng) 特性，如果確有必要可以畫出，但是盡可能不要畫出第三層系統(tǒng)特性。 3.3 系統(tǒng)接口設(shè)計(jì)系統(tǒng)接口設(shè)計(jì) 系統(tǒng)接口是一種非

38、可視的系統(tǒng)界面，在多數(shù)情況下，它對(duì)用戶是透明的。 本節(jié)將對(duì)系統(tǒng)接口作較為詳細(xì)的描述，并給出接口說(shuō)明清單。 3.3.1 系統(tǒng)接口表 接口作為系統(tǒng)的一種輸入輸出形式，分為網(wǎng)絡(luò)接口、數(shù)據(jù)庫(kù)接口、rs-232 串行通訊 接口、ieee485 串行總線接口、并行 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ì) 接

39、口 速率 接口 協(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)特

40、性。 備注 描述與該系統(tǒng)接口有關(guān)的其它注意事項(xiàng)。 說(shuō)明 描述與該系統(tǒng)接口表有關(guān)的其它注意事項(xiàng)。 3.3.2 系統(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ù)、等等。 3.4 系統(tǒng)完整性設(shè)計(jì)系統(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)英文名稱 含

41、義同上。 子系統(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)。 4. 系統(tǒng)出錯(cuò)處理設(shè)計(jì)系統(tǒng)出錯(cuò)處理設(shè)計(jì) 本節(jié)描述系統(tǒng)發(fā)生外界及內(nèi)在錯(cuò)誤時(shí)，所提供的錯(cuò)誤信息及處理方法，它包括系統(tǒng)出 錯(cuò)處理表及維護(hù)處理過(guò)程表。 4.1 系統(tǒng)出錯(cuò)處理表系統(tǒng)出錯(cuò)處理表 本表給出有關(guān)出錯(cuò)處理的產(chǎn)生原因、提示信息、以及建議處理方法。 當(dāng)系統(tǒng)由多個(gè)子

42、系統(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ò)誤原因 對(duì)該錯(cuò)誤產(chǎn)生原因的解釋與說(shuō)明。 錯(cuò)誤信息 產(chǎn)生該錯(cuò)誤時(shí)，向用戶發(fā)出的提示信息。 處理方式 對(duì)該錯(cuò)誤處理的一種建議，此項(xiàng)允許缺省。 備注 描述與該系統(tǒng)錯(cuò)誤有關(guān)的其它注意事項(xiàng)。 說(shuō)明 描述與該系

43、統(tǒng)錯(cuò)誤表有關(guān)的其它注意事項(xiàng)。 4.2 維護(hù)處理過(guò)程表維護(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)中文名稱： 處理過(guò)程處理過(guò)程錯(cuò)誤編號(hào) 英文名稱中文名稱 處理功能入口參數(shù)出口參數(shù)備注 說(shuō)明： 其中： 子系統(tǒng)編號(hào) 含義同上。 子系統(tǒng)英文名稱 含義同上。 子系統(tǒng)中文名稱 含義同上。 錯(cuò)誤編號(hào) 含義同上。 處理過(guò)程英文名稱 系統(tǒng)維護(hù)處理過(guò)程的英文正式名稱，將來(lái)用于軟件開發(fā)中，必須符合

44、命名規(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)。 5. 技術(shù)設(shè)計(jì)技術(shù)設(shè)計(jì) 系統(tǒng)技術(shù)設(shè)計(jì)描述系統(tǒng)各個(gè)特性實(shí)際使用的開發(fā)技術(shù)，以及具體開發(fā)技術(shù)使用時(shí)應(yīng)該 注意的事項(xiàng)。 5.1 系統(tǒng)開發(fā)技術(shù)說(shuō)明

45、表系統(tǒng)開發(fā)技術(shù)說(shuō)明表 本表描述系統(tǒng)各個(gè)特性開發(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)開發(fā)技術(shù)說(shuō)明表進(jìn) 行描述。系統(tǒng)開發(fā)技術(shù)說(shuō)明表的格式如下： 子系統(tǒng)編號(hào)： 子系統(tǒng)英文名稱： 子系統(tǒng)中文名稱： 開發(fā)技術(shù)開發(fā)技術(shù)技術(shù)編號(hào) 英文名稱中文名稱 處理功能系統(tǒng)特性編號(hào)備注 說(shuō)明： 其中： 子系統(tǒng)編號(hào) 含義同上。 子系統(tǒng)英文名稱 含義同上。 子系統(tǒng)中文名稱 含義同上。 技術(shù)編號(hào) 這個(gè)系統(tǒng)所使用各種技術(shù)的統(tǒng)一編號(hào)。 開發(fā)技術(shù)英文名稱 該開發(fā)技術(shù)的英文正式名稱，可以便

46、用縮寫。 該名稱應(yīng)該是常用的，并且為人們所普遍接受的。 開發(fā)技術(shù)中文名稱 該開發(fā)技術(shù)的中文正式名稱，是該開發(fā)技術(shù)英文名稱的中文說(shuō)明。 該名稱應(yīng)該是常用的，并且為人們所普遍接受的。 處理功能 描述本開發(fā)技術(shù)的處理目的。 系統(tǒng)特性編號(hào) 含義同上。 由于一項(xiàng)開發(fā)技術(shù)可能在多處使用，因此針對(duì)一項(xiàng)開發(fā)技術(shù)，有可能存在多個(gè) 系 統(tǒng)特性編號(hào)，在此必須一一列出。 備注 描述與該系統(tǒng)開發(fā)技術(shù)相關(guān)的其它注意事項(xiàng)。 說(shuō)明 描述與該系統(tǒng)開發(fā)技術(shù)說(shuō)明表有關(guān)的其它注意事項(xiàng)。 5.2 開發(fā)技術(shù)應(yīng)用說(shuō)明開發(fā)技術(shù)應(yīng)用說(shuō)明 逐項(xiàng)詳細(xì)描述系統(tǒng)開發(fā)技術(shù)說(shuō)明表中所列出各項(xiàng)系統(tǒng)開發(fā)技術(shù)使用的技術(shù)要點(diǎn)，以及 其它相關(guān)內(nèi)容，例如：所需的服務(wù)

47、、使用的動(dòng)態(tài)連接庫(kù)、調(diào)用的組件、等等。 6. 數(shù)據(jù)庫(kù)設(shè)計(jì)數(shù)據(jù)庫(kù)設(shè)計(jì) 如果該軟件產(chǎn)品需要使用數(shù)據(jù)庫(kù)，不論是使用數(shù)據(jù)庫(kù)平臺(tái)支撐的，還是采用由軟件產(chǎn) 品開發(fā)者自行定義的；都應(yīng)該在完成軟件產(chǎn)品需求分析報(bào)告后，開始進(jìn)行軟件產(chǎn)品詳細(xì)設(shè) 計(jì)之前，按照軟件產(chǎn)品數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明文檔模板完成數(shù)據(jù)庫(kù)設(shè)計(jì)工作。 7. 詞匯表詞匯表 列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫的定義(如有可能，列出相關(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ǔ)。

48、但是，對(duì)于無(wú)法回避的軟件專 業(yè)或者計(jì)算機(jī)專業(yè)術(shù)語(yǔ)，也應(yīng)該列入詞匯表，并且加以準(zhǔn)確定義。 8. 進(jìn)度計(jì)劃進(jìn)度計(jì)劃 列出進(jìn)度計(jì)劃，包括各子系統(tǒng)、各子模塊完成進(jìn)度計(jì)劃，人員配備計(jì)劃等。 附錄附錄 c 軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板軟件詳細(xì)設(shè)計(jì)報(bào)告文檔模板 1. 引言引言.35 1.1 編寫目的.35 1.2 項(xiàng)目風(fēng)險(xiǎn).35 1.3 文檔約定.35 1.4 預(yù)期讀者和閱讀建議.35 1.5 參考資料.36 2. 支撐環(huán)境支撐環(huán)境 .36 2.1 數(shù)據(jù)庫(kù)管理系統(tǒng).36 2.2 開發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口.37 2.3 硬件環(huán)境.37 2.4 網(wǎng)絡(luò)環(huán)境.38 2.5 多種支撐環(huán)境開發(fā)要點(diǎn).38 3. 部件詳

49、細(xì)設(shè)計(jì)部件詳細(xì)設(shè)計(jì) .38 4. 詞匯表詞匯表 .39 5. 部件表格式部件表格式 .40 6. 界面表格式界面表格式 .40 1. 引言引言 引言是對(duì)這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告的概覽，是為了幫助閱讀者了解這份文檔如何編 寫的，并且應(yīng)該如何閱讀、理解和解釋這份文檔。 1.1 編寫目的編寫目的 說(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ō)明書(如果該軟件產(chǎn)品需要數(shù)據(jù)庫(kù)支持)編寫的， 開發(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)確的描

50、述。 如果這份軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告只與整個(gè)系統(tǒng)的某一部分有關(guān)系，那么只定義軟件系 統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告中說(shuō)明的那個(gè)部分或子系統(tǒng)。 1.2 項(xiàng)目風(fēng)險(xiǎn)項(xiàng)目風(fēng)險(xiǎn) 具體說(shuō)明本軟件開發(fā)項(xiàng)目的全部風(fēng)險(xiǎn)承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng) 險(xiǎn)，首要風(fēng)險(xiǎn)承擔(dān)者包括： 任務(wù)提出者； 軟件開發(fā)者； 產(chǎn)品使用者。 1.3 文檔約定文檔約定 描述編寫文檔時(shí)所采用的標(biāo)準(zhǔn)(如果有標(biāo)準(zhǔn)的話)，或者各種編寫約定。編寫約定應(yīng)該 包括： 部件編號(hào)方式； 界面編號(hào)方式； 命名規(guī)范： 等等。 1.4 預(yù)期讀者和閱讀建議預(yù)期讀者和閱讀建議 列舉本軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告所針對(duì)的各種不同的預(yù)期讀者，例如，可能的讀者包括： 開發(fā)人員； 項(xiàng)目經(jīng)

51、理； 測(cè)試人員； 文檔編寫人員； 等等。 描述文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對(duì)每一類讀者提出最適合的文檔 閱讀建議。 1.5 參考資料參考資料 列舉編寫軟件系統(tǒng)詳細(xì)設(shè)計(jì)報(bào)告時(shí)所用到的參考文獻(xiàn)及資料，可能包括： 本項(xiàng)目的合同書； 上級(jí)機(jī)關(guān)有關(guān)本項(xiàng)目的批文； 本項(xiàng)目已經(jīng)批準(zhǔn)的計(jì)劃任務(wù)書； 用戶界面風(fēng)格指導(dǎo)； 開發(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)題名稱； 作者或者

52、合同簽約者； 文件編號(hào)或者版本號(hào)； 發(fā)表日期或者簽約日期； 出版單位或者資料來(lái)源。 2. 支撐環(huán)境支撐環(huán)境 2.1 數(shù)據(jù)庫(kù)管理系統(tǒng)數(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)不一定是最新的版

53、本號(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)(盤號(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ī)范 。 2.2 開發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接

54、口開發(fā)工具、中間件以及數(shù)據(jù)庫(kù)接口 描述所選用的工具軟件和中間件的名稱、版本號(hào)，以及開發(fā)工具與數(shù)據(jù)庫(kù)或者中間件 接口的情況。如果使用了多種開發(fā)工具、輔助開發(fā)工具、第三方軟件部件、多種中間件、 多種接口、等答應(yīng)該逐項(xiàng)分別描述，并且說(shuō)明每一項(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)。 語(yǔ)言或代碼集 同 2.1 中語(yǔ)言或代碼集。 數(shù)據(jù)庫(kù)接口名稱 描述數(shù)據(jù)庫(kù)接口的名稱，如果使用別名時(shí)，應(yīng)同時(shí)描述使用的別名。 數(shù)據(jù)庫(kù)接口方式 描述與數(shù)據(jù)庫(kù)接口的方式，并說(shuō)明該接口方式的特點(diǎn)；如

55、果需要，還應(yīng)該說(shuō)明 使 用時(shí)的注意事項(xiàng)。 數(shù)據(jù)庫(kù)接口設(shè)置 描述各種接口設(shè)置，包括：協(xié)議、端口號(hào)等等。 同時(shí)參照南京市交通局信息化數(shù)據(jù)庫(kù)建設(shè)規(guī)范 。 2.3 硬件環(huán)境硬件環(huán)境 描述所選用的硬件環(huán)境，各種機(jī)型，例如：服務(wù)器、工作站，應(yīng)該分別描述。需要描 述的內(nèi)容可能包括： 機(jī)型； 主頻； 內(nèi)存容量； 磁盤容量； 特殊部件； 操作系統(tǒng)； 使用位置； 等等。 2.4 網(wǎng)絡(luò)環(huán)境網(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ò)帶寬

56、； 路由組織； 加密傳輸方式； vpn 鏈路連接方式； 等等。 2.5 多種支撐環(huán)境開發(fā)要點(diǎn)多種支撐環(huán)境開發(fā)要點(diǎn) 當(dāng)軟件產(chǎn)品將來(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ì)描述各種軟件開發(fā)、調(diào)試、測(cè)試的環(huán)境，為了確實(shí)保 證軟件產(chǎn)品將來(lái)能夠在各種可能的運(yùn)行環(huán)境中正常運(yùn)行，還需要對(duì)軟件產(chǎn)品進(jìn)行嚴(yán)格的配 置管理。 3. 部件詳細(xì)設(shè)計(jì)部件詳細(xì)設(shè)計(jì) 這里所提及的軟件部件，系指能夠完成特定功能、相對(duì)獨(dú)立的一些代碼集合，它們可 以是插件、

57、組件、控件、函數(shù)、過(guò)程、子程序、動(dòng)態(tài)連接庫(kù)、等等。具體呈何種形態(tài)，取 決于實(shí)際采用的開發(fā)工具和將要實(shí)現(xiàn)的軟件結(jié)構(gòu)。 按照合適的順序，逐個(gè)描述軟件部件的詳細(xì)情況。描述的順序可以是按層次橫向進(jìn)行 描述，也可以是按模塊縱向進(jìn)行描述，總之描述的方式必須有利于讀者理解軟件結(jié)構(gòu)。 每個(gè)部件采用一張軟件部件表進(jìn)行描述，軟件部件表的格式見附表一，其中； 部件編號(hào) 軟件部件的統(tǒng)一順序編號(hào)；對(duì)于實(shí)行配置管理的軟件開發(fā)項(xiàng)目來(lái)說(shuō)，該編號(hào)必 須 與該部件在配置管理中的編號(hào)相同。 部件名稱 軟件部件的正式英文名稱，該名稱是程序中使用的實(shí)際名稱，必須符合國(guó)家相 關(guān)軟件命名標(biāo)準(zhǔn)。 所屬子系統(tǒng) 指該部件所屬的子系統(tǒng)； 對(duì)于不分

58、為多個(gè)子系統(tǒng)的軟件來(lái)說(shuō)，不必填寫該欄。 部件調(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ù)，該欄為空。 算法 指該部件的算法形式表示，如果很簡(jiǎn)單、或者不存在，也可以為空。 流程描述 指該部件的處理流程的詳細(xì)表示或描述。 部件表示形式 指該部件完成開發(fā)后的最終表示形式，具體形式取決于開發(fā)工具和軟件結(jié)構(gòu)， 表 示形式可能是： 插件、組件、

59、控件， 函數(shù)、過(guò)程、子程序， 存儲(chǔ)過(guò)程， 動(dòng)態(tài)連接庫(kù)， 等等。 運(yùn)行環(huán)境 描述該部件所適合的運(yùn)行環(huán)境，即說(shuō)明該部件是針對(duì)何種運(yùn)行環(huán)境所開發(fā)的； 可以直接描述運(yùn)行環(huán)境，也可以描述運(yùn)行環(huán)境的編號(hào)； 對(duì)于實(shí)行配置管理的軟件開發(fā)項(xiàng)目來(lái)說(shuō)，該描述必須與該部件在配置管理中的 描 相同。 性能要求 指開發(fā)該部件時(shí)必須滿足的專門要求，這些要求可以是： 精度 靈活性 響應(yīng)時(shí)間 可重用性 等等。 提出的要求一般不宜超過(guò) 3 項(xiàng)，以排列的先后順序表示優(yōu)先級(jí)。 4. 詞匯表詞匯表 列出本文件中用到的專業(yè)術(shù)語(yǔ)的定義，以及有關(guān)縮寫的定義(如有可能，列出相關(guān)的外 文原詞)。為了便于非軟件專業(yè)或者非計(jì)算機(jī)專業(yè)人士也能夠在一定

60、的范圍內(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)確 定義。 5. 部件表格式部件表格式 部件編號(hào)部件名稱 所屬子系統(tǒng) 部件調(diào)用者 部件被調(diào)用者 部件入口參數(shù) 部件入口參數(shù) 算法： 流程描述： 表示性能運(yùn)行環(huán)境 性能要求 說(shuō)明：如果軟件不見使用一張表表述不完時(shí)，可以采用續(xù)表描述，但是必須注明是那張表 的續(xù)表。 6. 界面表格式界面表格式 界面編號(hào)部件名稱 界面性質(zhì)界面介質(zhì) 表示形式： 界