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

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

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

3、列出進(jìn)行本產(chǎn)品開(kāi)發(fā)工作的假定和約束，例如經(jīng)費(fèi)限制、開(kāi)發(fā)期限等。列出本產(chǎn)品的最終用戶的特點(diǎn)，充分說(shuō)明操作人員、維護(hù)人員的教育水平和技術(shù)專長(zhǎng)以及本產(chǎn)品的預(yù)期使用頻度等重要約束。1.0.0, .需求規(guī)定1 對(duì)功能的規(guī)定本節(jié)依據(jù)合同中定義的系統(tǒng)組成部分分別描述其功能，描述應(yīng)包括：功能編號(hào)；所屬產(chǎn)品編號(hào)；優(yōu)先級(jí)；功能定義；功能描述。1 對(duì)性能的規(guī)定本節(jié)描述用戶對(duì)系統(tǒng)的性能需求，可能的系統(tǒng)性能需求有：系統(tǒng)響應(yīng)時(shí)間需求；系統(tǒng)開(kāi)放性需求；系統(tǒng)可靠性需求；系統(tǒng)可移植性和可擴(kuò)展性需求；系統(tǒng)安全性需求；現(xiàn)有資源利用性需求。1.2 精度說(shuō)明對(duì)該產(chǎn)品的輸入、輸出數(shù)據(jù)精度的要求，可能包括傳輸過(guò)程中的精度。1.2 時(shí)間特性

4、要求說(shuō)明對(duì)于該產(chǎn)品的時(shí)間特性要求，如對(duì)：a）響應(yīng)時(shí)間；b）更新處理時(shí)間；c）數(shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間；d）計(jì)算時(shí)間等的要求。1.2 靈活性說(shuō)明對(duì)該產(chǎn)品的靈活性的要求，即當(dāng)需求發(fā)生某些變化時(shí)，該產(chǎn)品對(duì)這些變化的適應(yīng)能力，如：a）操作方式上的變化；b）運(yùn)行環(huán)境的變化；c）同其他系統(tǒng)的接口的變化；d）精度和有效時(shí)限的變化；e）計(jì)劃的變化或改進(jìn)。對(duì)于為了提供這些靈活性而進(jìn)行的專門(mén)設(shè)計(jì)的部分應(yīng)該加以標(biāo)明。1 輸入輸出的要求解釋各輸入輸出的數(shù)據(jù)類型，并逐項(xiàng)說(shuō)明其媒體、格式、數(shù)值范圍、精度等。對(duì)軟件的數(shù)據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例，包括對(duì)硬拷貝報(bào)告（正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示

5、報(bào)告的描述。1 數(shù)據(jù)管理能力要求說(shuō)明需要管理的文卷和記錄的個(gè)數(shù)、表和文的大小規(guī)模，要按可預(yù)見(jiàn)的增長(zhǎng)對(duì)數(shù)據(jù)及分量的存儲(chǔ)要求做出估算。1 故障處理要求列出可能的軟件、硬件故障以及對(duì)各項(xiàng)性能而言所產(chǎn)生的后果和對(duì)故障處理的要求。1 其他要求如用戶單位對(duì)安全保密的要求，對(duì)使用方便的要求，對(duì)可維護(hù)性、可補(bǔ)充性、易讀性、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。2.0.0, .運(yùn)行環(huán)境規(guī)定2 設(shè)備列出該產(chǎn)品所需要的硬件環(huán)境。說(shuō)明其中的新型設(shè)備及其專門(mén)功能，包括：1.1 處理器型號(hào)及內(nèi)存容量；b）外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式。設(shè)備的型號(hào)及數(shù)量；輸入及輸出設(shè)備的型號(hào)和數(shù)量，聯(lián)機(jī)或脫機(jī)；數(shù)據(jù)通信設(shè)備的型號(hào)和

6、數(shù)量；e）功能鍵及其他專用硬件。2 支持軟件列出支持軟件。包括要用到的操作系統(tǒng)、編譯程序、測(cè)試軟件等。2 雙方簽字需求方（需方）：開(kāi)發(fā)方（供方）：日期：1.2概要設(shè)計(jì)說(shuō)明書(shū)概要設(shè)計(jì)說(shuō)明書(shū)格式規(guī)范是指在概要設(shè)計(jì)階段，制定概要設(shè)計(jì)報(bào)告所依據(jù)的標(biāo)準(zhǔn)，若在承接產(chǎn)品時(shí)，用戶提供了概要設(shè)計(jì)說(shuō)明書(shū)，則按此標(biāo)準(zhǔn)檢查概要設(shè)計(jì)報(bào)告是否在內(nèi)容上滿足要求，若未提供概要設(shè)計(jì)說(shuō)明書(shū)則需按此標(biāo)準(zhǔn)建立概要設(shè)計(jì)說(shuō)明書(shū)。這里提供一個(gè)標(biāo)準(zhǔn)以供參考。.導(dǎo)言目的說(shuō)明文檔的目的。范圍說(shuō)明文檔覆蓋的范圍。縮寫(xiě)說(shuō)明定義文檔中所涉及的縮略語(yǔ)（若無(wú)則填寫(xiě)無(wú)）術(shù)語(yǔ)定義定義文檔內(nèi)使用的特定術(shù)語(yǔ)（若無(wú)則填寫(xiě)無(wú)）引用標(biāo)準(zhǔn)列出文檔制定所依據(jù)、引用的標(biāo)準(zhǔn)（

7、若無(wú)則填寫(xiě)無(wú)）參考資料列出文檔制定所參考的資料（若無(wú)則填寫(xiě)無(wú)）版本更新信息記錄文檔版本修改的過(guò)程，具體版本更新記錄如表1所列表版本更新記錄修改編號(hào)修改日期修改后版本修改位置修改內(nèi)容概述.概述對(duì)系統(tǒng)定義和規(guī)格進(jìn)行分析，并以此確定：設(shè)計(jì)采用的標(biāo)準(zhǔn)和方法；系統(tǒng)結(jié)構(gòu)的考慮；錯(cuò)誤處理機(jī)制的考慮。.規(guī)格分析根據(jù)需求規(guī)格或產(chǎn)品規(guī)格對(duì)系統(tǒng)實(shí)現(xiàn)的功能進(jìn)行分析歸納，以便進(jìn)行概要設(shè)計(jì)。.系統(tǒng)體系結(jié)構(gòu)根據(jù)已選用的軟件、硬件以及網(wǎng)絡(luò)環(huán)境構(gòu)造系統(tǒng)的整體框架，劃分系統(tǒng)模塊，并對(duì)系統(tǒng)內(nèi)各個(gè)模塊之間的關(guān)系進(jìn)行定義。確定已定義的對(duì)象及其組件在系統(tǒng)內(nèi)如何傳輸、通信。如果本系統(tǒng)是用戶最終投入使用系統(tǒng)的一個(gè)子集或是將要使用現(xiàn)有的一些其

8、他相關(guān)系統(tǒng)，在此應(yīng)對(duì)他們各自的功能和相互之間的關(guān)系給予具體的描述?？赏ㄟ^(guò)圖形的方式表示系統(tǒng)體系結(jié)構(gòu).界面設(shè)計(jì)定義設(shè)計(jì)用戶的所有界面.接口定義通常設(shè)計(jì)應(yīng)考慮的接口包括：人機(jī)交互接口人機(jī)交互接口應(yīng)確定用戶采用何種方式同系統(tǒng)交互，如鍵盤(pán)錄入、鼠標(biāo)操作、文件輸入等以及具體的數(shù)據(jù)格式，其中包括具體的用戶界面的設(shè)計(jì)形式。盡早確定人機(jī)交互接口，有利于確定概要設(shè)計(jì)的其他方面。用戶界面設(shè)計(jì)原則：命令排序：（1）最常用的放在前面；（2）按習(xí)慣工作步驟排序；極小化：盡量少用鍵盤(pán)組合命令，減少用戶擊鍵次數(shù)；廣度和深度：由于人的記憶局限，層次不宜大于3;一致性：使用一致的術(shù)語(yǔ)、一致的步驟、一致的動(dòng)作行為；顯示提示信息；

9、減少用戶記憶內(nèi)容；存在刪除操作時(shí)。應(yīng)能恢復(fù)操作；用戶界面吸引人；網(wǎng)絡(luò)接口若本系統(tǒng)跨異種網(wǎng)絡(luò)運(yùn)行則應(yīng)確定網(wǎng)絡(luò)接口或采用何種網(wǎng)絡(luò)軟件，以使系統(tǒng)各部分間能有效地聯(lián)絡(luò)、通信、交換信息等，從而使整個(gè)系統(tǒng)緊密有效的結(jié)合在一起。系統(tǒng)與外部接口系統(tǒng)經(jīng)常會(huì)與外部進(jìn)行數(shù)據(jù)交換，因此應(yīng)確定數(shù)據(jù)交換的時(shí)機(jī)、方式（如是批處理方式還是實(shí)時(shí)處理）、數(shù)據(jù)交換的格式（如是采用數(shù)據(jù)包還是其他方式）等。系統(tǒng)內(nèi)模塊之間的接口系統(tǒng)內(nèi)部各模塊之間也會(huì)進(jìn)行數(shù)據(jù)交換，因此應(yīng)確定數(shù)據(jù)交換的時(shí)機(jī)、方式等。數(shù)據(jù)庫(kù)接口系統(tǒng)內(nèi)部的各種數(shù)據(jù)通常會(huì)以數(shù)據(jù)庫(kù)的方式保存，因此在接口定義時(shí)應(yīng)確定與數(shù)據(jù)庫(kù)進(jìn)行數(shù)據(jù)交換的數(shù)據(jù)格式、時(shí)機(jī)、方式等。.模塊設(shè)計(jì)根據(jù)項(xiàng)目的

10、時(shí)機(jī)需求情況，可將系統(tǒng)劃分成若干模塊，分別描述各模塊的功能。這樣可將復(fù)雜的系統(tǒng)簡(jiǎn)化、細(xì)化，有利于今后的設(shè)計(jì)和實(shí)現(xiàn)。劃分各模塊時(shí)，應(yīng)盡量使其具有封閉性和獨(dú)立性，具有低耦合性，減少各模塊之間的關(guān)聯(lián)，使其便于實(shí)現(xiàn)、調(diào)試、安裝和維護(hù)。模塊功能描述該模塊在整個(gè)系統(tǒng)中所處的位置和所起的作用以及和其他模塊的相互關(guān)系，該模塊要實(shí)現(xiàn)的功能，對(duì)外部輸入數(shù)據(jù)外部觸發(fā)機(jī)制的具體要求和規(guī)定。如果采用OO技術(shù)，可結(jié)合UseCase技術(shù)進(jìn)行描述。模塊對(duì)象（組件）對(duì)模塊涉及的輸入/輸出，用戶界面、對(duì)象或組件，對(duì)象或組件的關(guān)系以及功能實(shí)現(xiàn)流程進(jìn)行定義。如果采用OO技術(shù)，可使用順序（sequence）圖描述功能實(shí)現(xiàn)流程。對(duì)象設(shè)計(jì)

11、應(yīng)包括：ClassName（類名）；Describe（類描述）；Hierarchy（繼承關(guān)系）；PublicAttribute（公共屬性）PublicOperation（公共操作）PrivateAttribute（私有屬性）PrivateOperation（私有操作）ProtectedAttribute（保護(hù)屬性）ProtectedOperation（保護(hù)操作）組件設(shè)計(jì)應(yīng)包括：組件屬性；組件關(guān)聯(lián)；組件操作；實(shí)現(xiàn)約束。對(duì)象（組件）的觸發(fā)機(jī)制規(guī)定對(duì)象（組件）中各個(gè)操作在什么外部條件觸發(fā)下被調(diào)用以及調(diào)用后的結(jié)果。對(duì)象（組件）的關(guān)鍵算法如果對(duì)象（組件）中涉及關(guān)鍵算法，如采用何種算法加密、何種算法搜索等

12、，需在此規(guī)定并予以相應(yīng)的說(shuō)明。至于其他具體操作的算法可在系統(tǒng)構(gòu)造中去設(shè)計(jì)實(shí)現(xiàn)。.故障檢測(cè)和處理機(jī)制故障檢測(cè)和觸發(fā)機(jī)制系統(tǒng)發(fā)生故障可以有多種檢測(cè)機(jī)制，如自動(dòng)向上層匯報(bào)、由上層定時(shí)檢測(cè)、將故障寫(xiě)入錯(cuò)誤文件等。在此應(yīng)明確系統(tǒng)所采用的故障檢測(cè)機(jī)制。故障處理機(jī)制他描述故障發(fā)生后系統(tǒng)如何處理，如只發(fā)個(gè)消息顯示出錯(cuò)信息、寫(xiě)入一個(gè)文件、或采取相應(yīng)的措施，在這里應(yīng)進(jìn)行詳盡的描述。.數(shù)據(jù)庫(kù)設(shè)計(jì)數(shù)據(jù)庫(kù)管理系統(tǒng)選型明確指出選用的數(shù)據(jù)庫(kù)管理系統(tǒng)類型、版本、服務(wù)器與數(shù)據(jù)庫(kù)、客戶機(jī)與數(shù)據(jù)庫(kù)之間的接口。設(shè)計(jì)E-R圖根據(jù)系統(tǒng)數(shù)據(jù)實(shí)體之間的關(guān)系實(shí)際數(shù)據(jù)庫(kù)E-R圖。數(shù)據(jù)庫(kù)表設(shè)計(jì)基于E-R圖設(shè)計(jì)數(shù)據(jù)庫(kù)物理表。.系統(tǒng)開(kāi)發(fā)平臺(tái)根據(jù)概要設(shè)

13、計(jì)的結(jié)果選擇確定系統(tǒng)開(kāi)發(fā)所需的平臺(tái)，包括硬件平臺(tái)、操作系統(tǒng)以及開(kāi)發(fā)工具等。1.3詳細(xì)設(shè)計(jì)說(shuō)明書(shū).導(dǎo)言目的說(shuō)明文檔的目的范圍說(shuō)明文檔覆蓋的范圍縮寫(xiě)說(shuō)明定義文檔中所涉及的縮略語(yǔ)（若無(wú)則填寫(xiě)無(wú)）術(shù)語(yǔ)定義定義文檔內(nèi)使用的特定術(shù)語(yǔ)（若無(wú)則填寫(xiě)無(wú)）引用標(biāo)準(zhǔn)列出文檔制定所依據(jù)、引用的標(biāo)準(zhǔn)（若無(wú)則填寫(xiě)無(wú)）參考資料列出文檔制定所參考的資料（若無(wú)則填寫(xiě)無(wú)）版本更新信息記錄文檔版本修改的過(guò)程，具體版本更新記錄如表1所列表版本更新記錄修改編號(hào)修改日期修改后版本修改位置修改內(nèi)容概述.系統(tǒng)設(shè)計(jì)概述本小節(jié)描述的主要內(nèi)容包括:簡(jiǎn)要描述系統(tǒng)的整體結(jié)構(gòu)（文字和框圖相結(jié)合）模塊劃分和分布（如果采用OO技術(shù)，則可以Component

14、圖和Package圖表不）系統(tǒng)采用的技術(shù)和實(shí)現(xiàn)方法.詳細(xì)設(shè)計(jì)概述本小節(jié)以模塊為單位簡(jiǎn)要描述：模塊用途模塊功能特別約定.詳細(xì)設(shè)計(jì)本小節(jié)以模塊為單位詳細(xì)描述：模塊的定義模塊的關(guān)聯(lián)輸入/輸出數(shù)據(jù)說(shuō)明變量描述：重要的變量及其用途約束或限制條件實(shí)現(xiàn)描述/算法說(shuō)明說(shuō)明本模塊的實(shí)現(xiàn)流程，包括條件分支和異常處理模塊的應(yīng)用邏輯模塊的數(shù)據(jù)邏輯這部分可以通過(guò)流程圖或者偽代碼的方式實(shí)現(xiàn)。.程序提交清單程序提交清單以模塊為單位分別進(jìn)行描述，格式如表2所示。表程序提交清單格式模塊文件名文件類別用途編碼規(guī)范*編碼階段的產(chǎn)品是按照代碼標(biāo)準(zhǔn)和規(guī)范編寫(xiě)的源代碼，可在必要地時(shí)候進(jìn)行部署。所以提交的文檔包括：代碼標(biāo)準(zhǔn)和規(guī)范源代碼測(cè)試

15、文檔測(cè)試計(jì)劃文檔測(cè)試是比較復(fù)雜和困難的過(guò)程，為了很好控制測(cè)試的復(fù)雜性和困難性，需要仔細(xì)編寫(xiě)完整的測(cè)試文檔。這里我們提供一個(gè)可以作為參照的系統(tǒng)測(cè)試計(jì)劃模板。.介紹目的說(shuō)明文檔的目的。范圍說(shuō)明文檔覆蓋的范圍。編寫(xiě)說(shuō)明定義文檔中所涉及的縮略語(yǔ)（若無(wú)則填寫(xiě)無(wú)）術(shù)語(yǔ)定義定義文檔內(nèi)使用的特定術(shù)語(yǔ)（若無(wú)則填寫(xiě)無(wú)）引用標(biāo)準(zhǔn)列出文檔制定所依據(jù)、引用的標(biāo)準(zhǔn)（若無(wú)則填寫(xiě)無(wú)）參考資料列出文檔制定所參考的資料（若無(wú)則填寫(xiě)無(wú)）版本更新信息記錄文檔版本修改的過(guò)程，具體版本更新記錄如表1所列表1版本更新記錄修改編號(hào)修改日期修改后版本修改位置修改內(nèi)容概述.測(cè)試項(xiàng)目對(duì)被測(cè)試項(xiàng)目進(jìn)行描述。.測(cè)試特性描述測(cè)試的特性和不被測(cè)特性。.測(cè)

16、試方法分析和描述本次測(cè)試采用的測(cè)試方法和技術(shù)。.測(cè)試標(biāo)準(zhǔn)描述測(cè)試通過(guò)的標(biāo)準(zhǔn)以及測(cè)試審批的過(guò)程。測(cè)試掛起/恢復(fù)的條件。.系統(tǒng)測(cè)試交付物測(cè)試完成后提交的所有產(chǎn)品。.測(cè)試任務(wù).環(huán)境需求硬件需求軟件需求測(cè)試工具其他.角色和職責(zé).人員及培訓(xùn).系統(tǒng)測(cè)試進(jìn)度測(cè)試設(shè)計(jì)文檔測(cè)試設(shè)計(jì)主要是根據(jù)相應(yīng)的依據(jù)（需求、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)等）設(shè)計(jì)測(cè)試方案,測(cè)試的覆蓋率以及設(shè)計(jì)測(cè)試用例等。表6-13的測(cè)試覆蓋表和表6-14的測(cè)試用例表可以作為參照。表6-13測(cè)試用例覆蓋矩陣序號(hào)功能項(xiàng)預(yù)期結(jié)果優(yōu)先級(jí)測(cè)試用例表6-14測(cè)試用例編碼測(cè)試項(xiàng)目名稱：測(cè)試人員：測(cè)試時(shí)間：測(cè)試項(xiàng)目標(biāo)題：測(cè)試內(nèi)容：測(cè)試環(huán)境與系統(tǒng)配置：測(cè)試輸入數(shù)據(jù)：測(cè)試次數(shù)

17、：預(yù)期結(jié)果：測(cè)試過(guò)程：測(cè)試結(jié)果：測(cè)試結(jié)論：實(shí)現(xiàn)限制：備注：測(cè)試跟蹤文檔可以采用工具跟蹤測(cè)t的結(jié)果，如表6-15所列就是一個(gè)缺陷跟蹤的表格。目前市場(chǎng)上存在很多缺陷跟蹤的商用工具軟件。表6-15測(cè)試跟蹤記錄表序號(hào)時(shí)間事件描述錯(cuò)誤類型狀態(tài)處理結(jié)果測(cè)試人開(kāi)發(fā)人1231.5.4,測(cè)試總結(jié)文檔卜面的測(cè)試總結(jié)報(bào)告模板（可裁剪），可以參照。.介紹目的說(shuō)明文檔的目的。范圍說(shuō)明文檔覆蓋的范圍。編寫(xiě)說(shuō)明定義文檔中所涉及的縮略語(yǔ)（若無(wú)則填寫(xiě)無(wú)）術(shù)語(yǔ)定義定義文檔內(nèi)使用的特定術(shù)語(yǔ)（若無(wú)則填寫(xiě)無(wú)）引用標(biāo)準(zhǔn)列出文檔制定所依據(jù)、引用的標(biāo)準(zhǔn)（若無(wú)則填寫(xiě)無(wú)）參考資料列出文檔制定所參考的資料（若無(wú)則填寫(xiě)無(wú)）版本更新信息記錄文檔版本修改的過(guò)程，具體版本更新記錄如表1所列表1版本更新記錄修改編號(hào)修改日期修改后版本修改位置修改內(nèi)容概述.測(cè)試時(shí)間、地點(diǎn)和人員.測(cè)試環(huán)境描述.測(cè)試數(shù)據(jù)度量測(cè)試用例執(zhí)行度量測(cè)試進(jìn)度和工作量度量缺陷數(shù)據(jù)度量綜合數(shù)據(jù)分析計(jì)劃