軟件開發(fā)過程文檔規(guī)范

1、1.1 需求規(guī)格說明書需求規(guī)格相當于軟件開發(fā)的圖紙，一般說，軟件需求規(guī)格說明書的格式可以根據(jù)項目的具體情況采用不同的格式，沒有統(tǒng)一的標準。下面是一個可以參照的軟件需求規(guī)格說明書的模板。 1 導言1.1 目的說明編寫這份項目需求規(guī)格的目的，指出預期的讀者1.2 背景說明：a） 待開發(fā)的產品名稱；b） 本項目的任務提出者、開發(fā)者、用戶及實現(xiàn)該產品的單位；c） 該系統(tǒng)同其他系統(tǒng)的相互來往關系。1.3 縮寫說明縮寫縮寫說明列出本文件中用到的外文首字母組詞的原詞組。1.4 術語定義術語術語定義列出本文件中用到的專門術語的定義。1.5 參考資料編號參考資料版本號列出相關的參考資料。1.6 版本更新信息具體

2、版本更新記錄如表所列。表 版本更新記錄修改編號修改日期修改后版本修改位置修改內容概述2 任務概述2.1 系統(tǒng)定義本節(jié)描述內容包括：l 項目來源及背景；l 項目要達到的目標，如市場目標、技術目標等；l 系統(tǒng)整體結構，如系統(tǒng)框架、系統(tǒng)提供的主要功能，涉及的接口等；l 各組成部分結構，如果所定義的產品是一個更大的系統(tǒng)的一個組成部分，則應說明本產品與該系統(tǒng)中其他各組成部分之間的關系，為此可使用一張方框圖來說明該系統(tǒng)的組成和本產品同其他各部分的聯(lián)系和接口。2.2 應用環(huán)境本節(jié)應根據(jù)用戶的要求對系統(tǒng)的運行環(huán)境進行定義，描述內容包括：l 設備環(huán)境；l 系統(tǒng)運行硬件環(huán)境；l 系統(tǒng)運行軟件環(huán)境；l 系統(tǒng)運行網(wǎng)絡

3、環(huán)境；l 用戶操作模式；l 當前應用環(huán)境。2.3 假定和約束列出進行本產品開發(fā)工作的假定和約束，例如經(jīng)費限制、開發(fā)期限等。列出本產品的最終用戶的特點，充分說明操作人員、維護人員的教育水平和技術專長以及本產品的預期使用頻度等重要約束。3 需求規(guī)定1.1 對功能的規(guī)定本節(jié)依據(jù)合同中定義的系統(tǒng)組成部分分別描述其功能，描述應包括：l 功能編號；l 所屬產品編號；l 優(yōu)先級；l 功能定義；l 功能描述。1.2 對性能的規(guī)定本節(jié)描述用戶對系統(tǒng)的性能需求，可能的系統(tǒng)性能需求有：l 系統(tǒng)響應時間需求；l 系統(tǒng)開放性需求；l 系統(tǒng)可靠性需求；l 系統(tǒng)可移植性和可擴展性需求；l 系統(tǒng)安全性需求；l 現(xiàn)有資源利用性

4、需求。1.2.1 精度說明對該產品的輸入、輸出數(shù)據(jù)精度的要求，可能包括傳輸過程中的精度。1.2.2 時間特性要求說明對于該產品的時間特性要求，如對：a） 響應時間；b） 更新處理時間；c） 數(shù)據(jù)的轉換和傳送時間；d） 計算時間等的要求。1.2.3 靈活性說明對該產品的靈活性的要求，即當需求發(fā)生某些變化時，該產品對這些變化的適應能力，如：a） 操作方式上的變化；b） 運行環(huán)境的變化；c） 同其他系統(tǒng)的接口的變化；d） 精度和有效時限的變化；e） 計劃的變化或改進。對于為了提供這些靈活性而進行的專門設計的部分應該加以標明。1.3 輸入輸出的要求解釋各輸入輸出的數(shù)據(jù)類型，并逐項說明其媒體、格式、數(shù)值

5、范圍、精度等。對軟件的數(shù)據(jù)輸出及必須標明的控制輸出量進行解釋并舉例，包括對硬拷貝報告（正常結果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報告的描述。1.4 數(shù)據(jù)管理能力要求說明需要管理的文卷和記錄的個數(shù)、表和文的大小規(guī)模，要按可預見的增長對數(shù)據(jù)及分量的存儲要求做出估算。1.5 故障處理要求列出可能的軟件、硬件故障以及對各項性能而言所產生的后果和對故障處理的要求。1.6 其他要求如用戶單位對安全保密的要求，對使用方便的要求，對可維護性、可補充性、易讀性、可靠性、運行環(huán)境可轉換性的特殊要求等。4 運行環(huán)境規(guī)定4.1 設備列出該產品所需要的硬件環(huán)境。說明其中的新型設備及其專門功能，包括：a) 處理器型

6、號及內存容量；b) 外存容量、聯(lián)機或脫機、媒體及其存儲格式。設備的型號及數(shù)量；c) 輸入及輸出設備的型號和數(shù)量，聯(lián)機或脫機；d) 數(shù)據(jù)通信設備的型號和數(shù)量；e) 功能鍵及其他專用硬件。4.2 支持軟件列出支持軟件。包括要用到的操作系統(tǒng)、編譯程序、測試軟件等。4.3 雙方簽字需求方 （需方）：開發(fā)方 （供方）：日期：1.2 概要設計說明書概要設計說明書格式規(guī)范是指在概要設計階段，制定概要設計報告所依據(jù)的標準，若在承接產品時，用戶提供了概要設計說明書，則按此標準檢查概要設計報告是否在內容上滿足要求，若未提供概要設計說明書則需按此標準建立概要設計說明書。這里提供一個標準以供參考。1 導言1.1 目的

7、說明文檔的目的。1.2 范圍說明文檔覆蓋的范圍。1.3 縮寫說明定義文檔中所涉及的縮略語 （若無則填寫無）1.4 術語定義定義文檔內使用的特定術語 （若無則填寫無）1.5 引用標準列出文檔制定所依據(jù)、引用的標準 （若無則填寫無）1.6 參考資料列出文檔制定所參考的資料 （若無則填寫無）1.7 版本更新信息記錄文檔版本修改的過程，具體版本更新記錄如表1所列表 版本更新記錄修改編號修改日期修改后版本修改位置修改內容概述2 概述對系統(tǒng)定義和規(guī)格進行分析，并以此確定：l 設計采用的標準和方法；l 系統(tǒng)結構的考慮；l 錯誤處理機制的考慮。3 規(guī)格分析根據(jù)需求規(guī)格或產品規(guī)格對系統(tǒng)實現(xiàn)的功能進行分析歸納，以

8、便進行概要設計。4 系統(tǒng)體系結構根據(jù)已選用的軟件、硬件以及網(wǎng)絡環(huán)境構造系統(tǒng)的整體框架，劃分系統(tǒng)模塊，并對系統(tǒng)內各個模塊之間的關系進行定義。確定已定義的對象及其組件在系統(tǒng)內如何傳輸、通信。如果本系統(tǒng)是用戶最終投入使用系統(tǒng)的一個子集或是將要使用現(xiàn)有的一些其他相關系統(tǒng)，在此應對他們各自的功能和相互之間的關系給予具體的描述?？赏ㄟ^圖形的方式表示系統(tǒng)體系結構5 界面設計定義設計用戶的所有界面6 接口定義通常設計應考慮的接口包括：人機交互接口人機交互接口應確定用戶采用何種方式同系統(tǒng)交互，如鍵盤錄入、鼠標操作、文件輸入等以及具體的數(shù)據(jù)格式，其中包括具體的用戶界面的設計形式。盡早確定人機交互接口，有利于確定概

9、要設計的其他方面。用戶界面設計原則：l 命令排序：（1）最常用的放在前面； （2）按習慣工作步驟排序；l 極小化：盡量少用鍵盤組合命令，減少用戶擊鍵次數(shù)；l 廣度和深度：由于人的記憶局限，層次不宜大于3；l 一致性：使用一致的術語、一致的步驟、一致的動作行為；l 顯示提示信息；l 減少用戶記憶內容；l 存在刪除操作時。應能恢復操作；l 用戶界面吸引人；網(wǎng)絡接口若本系統(tǒng)跨異種網(wǎng)絡運行則應確定網(wǎng)絡接口或采用何種網(wǎng)絡軟件，以使系統(tǒng)各部分間能有效地聯(lián)絡、通信、交換信息等，從而使整個系統(tǒng)緊密有效的結合在一起。系統(tǒng)與外部接口系統(tǒng)經(jīng)常會與外部進行數(shù)據(jù)交換，因此應確定數(shù)據(jù)交換的時機、方式（如是批處理方式還是實

10、時處理）、數(shù)據(jù)交換的格式（如是采用數(shù)據(jù)包還是其他方式）等。系統(tǒng)內模塊之間的接口系統(tǒng)內部各模塊之間也會進行數(shù)據(jù)交換，因此應確定數(shù)據(jù)交換的時機、方式等。數(shù)據(jù)庫接口系統(tǒng)內部的各種數(shù)據(jù)通常會以數(shù)據(jù)庫的方式保存，因此在接口定義時應確定與數(shù)據(jù)庫進行數(shù)據(jù)交換的數(shù)據(jù)格式、時機、方式等。7 模塊設計根據(jù)項目的時機需求情況，可將系統(tǒng)劃分成若干模塊，分別描述各模塊的功能。這樣可將復雜的系統(tǒng)簡化、細化，有利于今后的設計和實現(xiàn)。劃分各模塊時，應盡量使其具有封閉性和獨立性，具有低耦合性，減少各模塊之間的關聯(lián)，使其便于實現(xiàn)、調試、安裝和維護。7.1 模塊功能描述該模塊在整個系統(tǒng)中所處的位置和所起的作用以及和其他模塊的相互關

11、系，該模塊要實現(xiàn)的功能，對外部輸入數(shù)據(jù)外部觸發(fā)機制的具體要求和規(guī)定。如果采用OO技術，可結合Use Case技術進行描述。7.2 模塊對象（組件）對模塊涉及的輸入/輸出，用戶界面、對象或組件，對象或組件的關系以及功能實現(xiàn)流程進行定義。如果采用OO技術，可使用順序（sequence）圖描述功能實現(xiàn)流程。對象設計應包括：Class Name （類名）；Describe （類描述）；Hierarchy （繼承關系）；Public Attribute （公共屬性）Public Operation （公共操作）Private Attribute （私有屬性）Private Operation （私有操作

12、）Protected Attribute （保護屬性）Protected Operation （保護操作）組件設計應包括：l 組件屬性；l 組件關聯(lián)；l 組件操作；l 實現(xiàn)約束。7.3 對象（組件）的觸發(fā)機制規(guī)定對象（組件）中各個操作在什么外部條件觸發(fā)下被調用以及調用后的結果。7.4 對象（組件）的關鍵算法如果對象（組件）中涉及關鍵算法，如采用何種算法加密、何種算法搜索等，需在此規(guī)定并予以相應的說明。至于其他具體操作的算法可在系統(tǒng)構造中去設計實現(xiàn)。8 故障檢測和處理機制8.1 故障檢測和觸發(fā)機制系統(tǒng)發(fā)生故障可以有多種檢測機制，如自動向上層匯報、由上層定時檢測、將故障寫入錯誤文件等。在此應明確系

13、統(tǒng)所采用的故障檢測機制。8.2 故障處理機制他描述故障發(fā)生后系統(tǒng)如何處理，如只發(fā)個消息顯示出錯信息、寫入一個文件、或采取相應的措施，在這里應進行詳盡的描述。9 數(shù)據(jù)庫設計9.1 數(shù)據(jù)庫管理系統(tǒng)選型明確指出選用的數(shù)據(jù)庫管理系統(tǒng)類型、版本、服務器與數(shù)據(jù)庫、客戶機與數(shù)據(jù)庫之間的接口。9.2 設計E-R圖根據(jù)系統(tǒng)數(shù)據(jù)實體之間的關系實際數(shù)據(jù)庫E-R圖。9.3 數(shù)據(jù)庫表設計基于E-R圖設計數(shù)據(jù)庫物理表。10系統(tǒng)開發(fā)平臺根據(jù)概要設計的結果選擇確定系統(tǒng)開發(fā)所需的平臺，包括硬件平臺、操作系統(tǒng)以及開發(fā)工具等。1.3 詳細設計說明書1 導言1.1 目的說明文檔的目的1.2 范圍說明文檔覆蓋的范圍1.3 縮寫說明定義

14、文檔中所涉及的縮略語（若無則填寫無）1.4 術語定義定義文檔內使用的特定術語（若無則填寫無）1.5 引用標準列出文檔制定所依據(jù)、引用的標準（若無則填寫無）1.6 參考資料列出文檔制定所參考的資料（若無則填寫無）1.7 版本更新信息記錄文檔版本修改的過程，具體版本更新記錄如表1所列表 版本更新記錄修改編號修改日期修改后版本修改位置修改內容概述2 系統(tǒng)設計概述本小節(jié)描述的主要內容包括：l 簡要描述系統(tǒng)的整體結構（文字和框圖相結合）l 模塊劃分和分布（如果采用OO技術，則可以Component圖和Package圖表示）l 系統(tǒng)采用的技術和實現(xiàn)方法3 詳細設計概述本小節(jié)以模塊為單位簡要描述：l 模塊用

15、途l 模塊功能l 特別約定4 詳細設計本小節(jié)以模塊為單位詳細描述：l 模塊的定義l 模塊的關聯(lián)l 輸入/輸出數(shù)據(jù)說明n 變量描述：重要的變量及其用途n 約束或限制條件l 實現(xiàn)描述/算法說明n 說明本模塊的實現(xiàn)流程，包括條件分支和異常處理n 模塊的應用邏輯n 模塊的數(shù)據(jù)邏輯這部分可以通過流程圖或者偽代碼的方式實現(xiàn)。5 程序提交清單程序提交清單以模塊為單位分別進行描述，格式如表2所示。表 程序提交清單格式模塊文件名文件類別用途1.4 編碼規(guī)范*編碼階段的產品是按照代碼標準和規(guī)范編寫的源代碼，可在必要地時候進行部署。所以提交的文檔包括：l 代碼標準和規(guī)范l 源代碼1.5 測試文檔1.5.1. 測試計

16、劃文檔測試是比較復雜和困難的過程，為了很好控制測試的復雜性和困難性，需要仔細編寫完整的測試文檔。這里我們提供一個可以作為參照的系統(tǒng)測試計劃模板。1. 介紹1.1 目的 說明文檔的目的。1.2 范圍 說明文檔覆蓋的范圍。1.3 編寫說明定義文檔中所涉及的縮略語 （若無則填寫無）1.4 術語定義定義文檔內使用的特定術語 （若無則填寫無）1.5 引用標準列出文檔制定所依據(jù)、引用的標準 （若無則填寫無）1.6 參考資料列出文檔制定所參考的資料 （若無則填寫無）1.7 版本更新信息記錄文檔版本修改的過程，具體版本更新記錄如表1所列表1 版本更新記錄修改編號修改日期修改后版本修改位置修改內容概述1 測試項

17、目對被測試項目進行描述。2 測試特性描述測試的特性和不被測特性。3 測試方法分析和描述本次測試采用的測試方法和技術。4 測試標準描述測試通過的標準以及測試審批的過程。測試掛起/恢復的條件。5 系統(tǒng)測試交付物測試完成后提交的所有產品。6 測試任務7 環(huán)境需求8.1 硬件需求8.2 軟件需求8.3 測試工具8.4 其他8 角色和職責9 人員及培訓10 系統(tǒng)測試進度1.5.2. 測試設計文檔測試設計主要是根據(jù)相應的依據(jù)（需求、概要設計、詳細設計等） 設計測試方案，測試的覆蓋率以及設計測試用例等。表6-13的測試覆蓋表和表6-14的測試用例表可以作為參照。表6-13 測試用例覆蓋矩陣序號功能項預期結果

18、優(yōu)先級測試用例表6-14 測試用例編碼測試項目名稱：測試人員：測試時間：測試項目標題：測試內容：測試環(huán)境與系統(tǒng)配置：測試輸入數(shù)據(jù)：測試次數(shù)：預期結果：測試過程：測試結果：測試結論：實現(xiàn)限制：備注：1.5.3. 測試跟蹤文檔可以采用工具跟蹤測試的結果，如表6-15所列就是一個缺陷跟蹤的表格。目前市場上存在很多缺陷跟蹤的商用工具軟件。表6-15 測試跟蹤記錄表序 號時 間事件描述錯誤類型狀 態(tài)處理結果測試人開發(fā)人1231.5.4. 測試總結文檔下面的測試總結報告模板（可裁剪），可以參照。1 介紹1.1 目的 說明文檔的目的。1.2 范圍 說明文檔覆蓋的范圍。1.3 編寫說明定義文檔中所涉及的縮略語 （若無則填寫無）1.4 術語定義定義文檔內使用的特定術語 （若無則填寫無）1.5 引用標準列出文檔制定所依據(jù)、引用的標準 （若無則填寫無）1.6 參考資料列出文檔制定所參考的資料 （若無則填寫無）1.7 版本更新信息記錄文檔版本修改的過程，具體版本更新記錄如表1所列表1 版本更新記錄修改編號修改日期修改后版本修改位置修改內容概述2 測試時間、地點和人員3 測試環(huán)境描述4 測試數(shù)據(jù)度量4.1 測試用例執(zhí)行度量4.2 測試進度和工作量度量4.3 缺陷數(shù)據(jù)度量4.4 綜合數(shù)據(jù)分析計劃進度偏差 = (實際進度 計劃進度) / 計劃