軟件開發(fā)標(biāo)準(zhǔn)規(guī)范文檔

軟件開發(fā)標(biāo)準(zhǔn)規(guī)范文檔篇一：軟件開發(fā)技術(shù)文檔編寫規(guī)范==軟件開發(fā)技術(shù)文檔編寫規(guī)范在項(xiàng)目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編制要求具有針對(duì)性、精確性、清晰性、完整性、靈活性、可追溯性。

可行性分析報(bào)告：說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會(huì)因素上的可行性，評(píng)述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說明并論證所選定實(shí)施方案的理由。

項(xiàng)目開發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。

軟件需求說明書（軟件規(guī)格說明書）：對(duì)所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。它是在用戶與開發(fā)人員雙方對(duì)軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的，也是實(shí)施開發(fā)工作的基礎(chǔ)。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。

概要設(shè)計(jì)說明書：該說明書是概要實(shí)際階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)提供基礎(chǔ)。

詳細(xì)設(shè)計(jì)說明書：著重描述每一模塊是怎樣實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。

用戶操作手冊(cè)：本手冊(cè)詳細(xì)描述軟件的功能、性能和用戶界面，使用戶對(duì)如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識(shí)，特別是操作方法的具體細(xì)節(jié)。

測(cè)試計(jì)劃：為做好集成測(cè)試和驗(yàn)收測(cè)試，需為如何組織測(cè)試制訂實(shí)施計(jì)劃。計(jì)劃應(yīng)包括測(cè)試的內(nèi)容、進(jìn)度、條件、人員、測(cè)試用例的選取原則、測(cè)試結(jié)果允許的偏差范圍等。

測(cè)試分析報(bào)告：測(cè)試工作完成以后，應(yīng)提交測(cè)試計(jì)劃執(zhí)行情況的說明，對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論意見。

開發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告，報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等。

項(xiàng)目開發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力，此外，還需對(duì)開發(fā)工作做出評(píng)價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。

軟件維護(hù)手冊(cè)：主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的說明，便于軟件的維護(hù)。

軟件問題報(bào)告：指出軟件問題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等，為軟件修改提供準(zhǔn)備文檔。

軟件修改報(bào)告：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對(duì)其進(jìn)行修正、更改等問題，應(yīng)將存在的問題、修改的考慮以及修改的影響作出詳細(xì)的描述，提交審批。1可行性分析報(bào)告1引言1.1編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對(duì)象。1.2項(xiàng)目背景：應(yīng)包括●所建議開發(fā)軟件的名稱●項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)軟件的單位●項(xiàng)目與其他軟件或其他系統(tǒng)的關(guān)系。1.3定義：列出文檔中用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文。1.4參考資料：列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文●與項(xiàng)目有關(guān)的已發(fā)表的資料●文檔中所引用的資料，所采用的軟件標(biāo)準(zhǔn)或規(guī)范2可行性研究的前提2.1要求：列出并說明建議開發(fā)軟件的的基本要求，如●功能●性能●輸入/輸出●基本的數(shù)據(jù)流程和處理流程●安全與保密要求●與軟件相關(guān)的其他系統(tǒng)●完成日期2.2目標(biāo)：可包括●人力與設(shè)備費(fèi)用的節(jié)省●處理速度的提高●控制精度或生產(chǎn)力的提高●管理信息服務(wù)的改進(jìn)●決策系統(tǒng)的改進(jìn)●人員工作效率的提高2.3條件、假定和限制：可包括●建議開發(fā)軟件運(yùn)行的最短壽命●進(jìn)行顯然方案選擇比較的期限●經(jīng)費(fèi)來源和使用限制●法律和政策方面的限制●硬件、軟件、運(yùn)行環(huán)境和開發(fā)環(huán)境的條件和限制●可利用的信息和資源●建議開發(fā)軟件投入使用的最遲時(shí)間2.4可行性研究方法2.5決定可行性的主要因素3對(duì)現(xiàn)有系統(tǒng)的分析3.1處理流程和數(shù)據(jù)流程3.2工作負(fù)荷3.3費(fèi)用支出：如人力、設(shè)備、空間、支持性服務(wù)、材料等項(xiàng)開支3.4人員：列出所需人員的專業(yè)技術(shù)類別和數(shù)量3.5設(shè)備3.6局限性：說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)4所建議技術(shù)可行性分析4.1對(duì)系統(tǒng)的簡(jiǎn)要描述4.2與現(xiàn)有系統(tǒng)比較的優(yōu)越性4.3處理流程和數(shù)據(jù)流程4.4采用建議系統(tǒng)可能帶來的影響●對(duì)設(shè)備的影響●對(duì)現(xiàn)有軟件的影響●對(duì)用戶的影響●對(duì)系統(tǒng)運(yùn)行的影響●對(duì)開發(fā)環(huán)境的影響●對(duì)經(jīng)費(fèi)支出的影響4.5技術(shù)可行性評(píng)價(jià):包括●在限制條件下，功能目的是否達(dá)到●利用現(xiàn)有技術(shù)，功能目的是否達(dá)到●對(duì)開發(fā)人員數(shù)量和質(zhì)量的要求，并說明能否滿足●在規(guī)定的期限內(nèi)，開發(fā)能否完成5所建議系統(tǒng)經(jīng)濟(jì)可行性分析5.1支出5.2效益5.3收益/投資比5.4投資回收周期5.5敏感性分析：指一些關(guān)鍵性因素，如：●系統(tǒng)生存周期長(zhǎng)短●系統(tǒng)工作負(fù)荷量●處理速度要求●設(shè)備和軟件配置變化對(duì)支出和效益的影響等的分析6社會(huì)因素可行性分析6.1法律因素：如●合同責(zé)任●侵犯專利權(quán)●侵犯版權(quán)6.2用戶使用可行性：如●用戶單位的行政管理●工作制度●人員素質(zhì)等能否滿足要求7其他可供選擇的方案逐個(gè)闡明其它可供選擇的方案，并重點(diǎn)說明未被推薦的理由。8結(jié)論意見●可著手組織開發(fā)●需等待若干條件具備后才能開發(fā)●需對(duì)開發(fā)目標(biāo)進(jìn)行某些修改●不能進(jìn)行或不必進(jìn)行●其它2項(xiàng)目開發(fā)計(jì)劃1引言1.1編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對(duì)象1.2項(xiàng)目背景：應(yīng)包括●項(xiàng)目的委托單位、開發(fā)單位和主管部門；●該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。1.3定義：列出文檔中用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文1.4參考資料：可包括：●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文●文檔所引用的資料、規(guī)范等●列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源；2項(xiàng)目概述2.1工作內(nèi)容:簡(jiǎn)要說明項(xiàng)目的各項(xiàng)主要工作，介紹所開發(fā)軟件的功能、性能等；若不編寫可行性研究報(bào)告；則應(yīng)在本節(jié)給出較詳細(xì)的介紹；2.2條件與限制:闡明為完成項(xiàng)目應(yīng)具備的條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時(shí)還應(yīng)說明用戶及分合同承擔(dān)的工作、完成期限及其他條件與限制。2.3產(chǎn)品2.3.1程序：列出應(yīng)交付的程序名稱、使用的語(yǔ)言及存儲(chǔ)形式。2.3.2文檔：列出應(yīng)交付的文檔。2.4運(yùn)行環(huán)境：應(yīng)包括硬件環(huán)境、軟件環(huán)境。2.5服務(wù)：闡明開發(fā)單位可向用戶提供的服務(wù)。如人員培訓(xùn)、安裝、保修、維護(hù)和其他運(yùn)行支持。2.6驗(yàn)收標(biāo)準(zhǔn)3實(shí)施計(jì)劃3.1任務(wù)分解：任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。3.2進(jìn)度：按階段完成的項(xiàng)目，用圖表說明開始時(shí)間、完成時(shí)間。3.3預(yù)算3.4關(guān)鍵問題：說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件、技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，并說明對(duì)策。4人員組織及分工5交付期限6專題計(jì)劃要點(diǎn)如測(cè)試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。篇二：軟件開發(fā)過程文檔規(guī)范1.1需求規(guī)格說明書需求規(guī)格相當(dāng)于軟件開發(fā)的圖紙，一般說，軟件需求規(guī)格說明書的格式可以根據(jù)項(xiàng)目的具體情況采用不同的格式，沒有統(tǒng)一的標(biāo)準(zhǔn)。下面是一個(gè)可以參照的軟件需求規(guī)格說明書的模板。1．導(dǎo)言1.1目的[說明編寫這份項(xiàng)目需求規(guī)格的目的，指出預(yù)期的讀者]1.2背景說明：a）待開發(fā)的產(chǎn)品名稱；b）本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該產(chǎn)品的單位；c）該系統(tǒng)同其他系統(tǒng)的相互來往關(guān)系。1.3縮寫說明[縮寫][縮寫說明]列出本文件中用到的外文首字母組詞的原詞組。1.4術(shù)語(yǔ)定義[術(shù)語(yǔ)][術(shù)語(yǔ)定義]列出本文件中用到的專門術(shù)語(yǔ)的定義。1.5參考資料[編號(hào)]《參考資料》[版本號(hào)]列出相關(guān)的參考資料。1.6版本更新信息具體版本更新記錄如表所列。表版本更新記錄2．任務(wù)概述2.1系統(tǒng)定義本節(jié)描述內(nèi)容包括：?項(xiàng)目來源及背景；?項(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)說明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系，為此可使用一張方框圖來說明該系統(tǒng)的組成和本產(chǎn)品同其他各部分的聯(lián)系和接口。2.2應(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)境。2.3假定和約束列出進(jìn)行本產(chǎn)品開發(fā)工作的假定和約束，例如經(jīng)費(fèi)限制、開發(fā)期限等。列出本產(chǎn)品的最終用戶的特點(diǎn)，充分說明操作人員、維護(hù)人員的教育水平和技術(shù)專長(zhǎng)以及本產(chǎn)品的預(yù)期使用頻度等重要約束。3．需求規(guī)定1.1對(duì)功能的規(guī)定本節(jié)依據(jù)合同中定義的系統(tǒng)組成部分分別描述其功能，描述應(yīng)包括：?功能編號(hào)；?所屬產(chǎn)品編號(hào)；?優(yōu)先級(jí)；?功能定義；?功能描述。1.2對(duì)性能的規(guī)定本節(jié)描述用戶對(duì)系統(tǒng)的性能需求，可能的系統(tǒng)性能需求有：?系統(tǒng)響應(yīng)時(shí)間需求；?系統(tǒng)開放性需求；?系統(tǒng)可靠性需求；?系統(tǒng)可移植性和可擴(kuò)展性需求；?系統(tǒng)安全性需求；?現(xiàn)有資源利用性需求。1.2.1精度說明對(duì)該產(chǎn)品的輸入、輸出數(shù)據(jù)精度的要求，可能包括傳輸過程中的精度。1.2.2時(shí)間特性要求說明對(duì)于該產(chǎn)品的時(shí)間特性要求，如對(duì)：a）響應(yīng)時(shí)間；b）更新處理時(shí)間；c）數(shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間；d）計(jì)算時(shí)間等的要求。1.2.3靈活性說明對(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)行的專門設(shè)計(jì)的部分應(yīng)該加以標(biāo)明。1.3輸入輸出的要求解釋各輸入輸出的數(shù)據(jù)類型，并逐項(xiàng)說明其媒體、格式、數(shù)值范圍、精度等。對(duì)軟件的數(shù)據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例，包括對(duì)硬拷貝報(bào)告（正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報(bào)告的描述。1.4數(shù)據(jù)管理能力要求說明需要管理的文卷和記錄的個(gè)數(shù)、表和文的大小規(guī)模，要按可預(yù)見的增長(zhǎng)對(duì)數(shù)據(jù)及分量的存儲(chǔ)要求做出估算。1.5故障處理要求列出可能的軟件、硬件故障以及對(duì)各項(xiàng)性能而言所產(chǎn)生的后果和對(duì)故障處理的要求。1.6其他要求如用戶單位對(duì)安全保密的要求，對(duì)使用方便的要求，對(duì)可維護(hù)性、可補(bǔ)充性、易讀性、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。4．運(yùn)行環(huán)境規(guī)定4.1設(shè)備列出該產(chǎn)品所需要的硬件環(huán)境。說明其中的新型設(shè)備及其專門功能，包括：a)處理器型號(hào)及內(nèi)存容量；b)外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式。設(shè)備的型號(hào)及數(shù)量；c)輸入及輸出設(shè)備的型號(hào)和數(shù)量，聯(lián)機(jī)或脫機(jī)；d)數(shù)據(jù)通信設(shè)備的型號(hào)和數(shù)量；e)功能鍵及其他專用硬件。4.2支持軟件列出支持軟件。包括要用到的操作系統(tǒng)、編譯程序、測(cè)試軟件等。4.3雙方簽字需求方（需方）：開發(fā)方（供方）：日期：1.2概要設(shè)計(jì)說明書概要設(shè)計(jì)說明書格式規(guī)范是指在概要設(shè)計(jì)階段，制定概要設(shè)計(jì)報(bào)告所依據(jù)的標(biāo)準(zhǔn)，若在承接產(chǎn)品時(shí)，用戶提供了概要設(shè)計(jì)說明書，則按此標(biāo)準(zhǔn)檢查概要設(shè)計(jì)報(bào)告是否在內(nèi)容上滿足要求，若未提供概要設(shè)計(jì)說明書則需按此標(biāo)準(zhǔn)建立概要設(shè)計(jì)說明書。這里提供一個(gè)標(biāo)準(zhǔn)以供參考。1．導(dǎo)言1.1目的說明文檔的目的。1.2范圍說明文檔覆蓋的范圍。1.3縮寫說明定義文檔中所涉及的縮略語(yǔ)（若無則填寫無）1.4術(shù)語(yǔ)定義定義文檔內(nèi)使用的特定術(shù)語(yǔ)（若無則填寫無）1.5引用標(biāo)準(zhǔn)列出文檔制定所依據(jù)、引用的標(biāo)準(zhǔn)（若無則填寫無）1.6參考資料列出文檔制定所參考的資料（若無則填寫無）1.7版本更新信息記錄文檔版本修改的過程，具體版本更新記錄如表1所列表版本更新記錄2．概述對(duì)系統(tǒng)定義和規(guī)格進(jìn)行分析，并以此確定：?設(shè)計(jì)采用的標(biāo)準(zhǔn)和方法；?系統(tǒng)結(jié)構(gòu)的考慮；?錯(cuò)誤處理機(jī)制的考慮。3．規(guī)格分析根據(jù)需求規(guī)格或產(chǎn)品規(guī)格對(duì)系統(tǒng)實(shí)現(xiàn)的功能進(jìn)行分析歸納，以便進(jìn)行概要設(shè)計(jì)。4．系統(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)有的一些其他相關(guān)系統(tǒng)，在此應(yīng)對(duì)他們各自的功能和相互之間的關(guān)系給予具體的描述。[可通過圖形的方式表示系統(tǒng)體系結(jié)構(gòu)]5．界面設(shè)計(jì)定義設(shè)計(jì)用戶的所有界面6．接口定義通常設(shè)計(jì)應(yīng)考慮的接口包括：人機(jī)交互接口人機(jī)交互接口應(yīng)確定用戶采用何種方式同系統(tǒng)交互，如鍵盤錄入、鼠標(biāo)操作、文件輸入等以及具體的數(shù)據(jù)格式，其中包括具體的用戶界面的設(shè)計(jì)形式。盡早確定人機(jī)交互接口，有利于確定概要設(shè)計(jì)的其他方面。用戶界面設(shè)計(jì)原則：?命令排序：（1）最常用的放在前面；（2）按習(xí)慣工作步驟排序；?極小化：盡量少用鍵盤組合命令，減少用戶擊鍵次數(shù)；?廣度和深度：由于人的記憶局限，層次不宜大于3；?一致性：使用一致的術(shù)語(yǔ)、一致的步驟、一致的動(dòng)作行為；?顯示提示信息；?減少用戶記憶內(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ī)、方式等。7．模塊設(shè)計(jì)根據(jù)項(xiàng)目的時(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ù)。7.1模塊功能描述該模塊在整個(gè)系統(tǒng)中所處的位置和所起的作用以及和其他模塊的相互關(guān)系，該模塊要實(shí)現(xiàn)的功能，對(duì)外部輸入數(shù)據(jù)外部觸發(fā)機(jī)制的具體要求和規(guī)定。如果采用OO技術(shù)，可結(jié)合UseCase技術(shù)進(jìn)行描述。7.2模塊對(duì)象（組件）對(duì)模塊涉及的輸入/輸出，用戶界面、對(duì)象或組件，對(duì)象或組件的關(guān)系以及功能實(shí)現(xiàn)流程進(jìn)行定義。如果采用OO技術(shù)，可使用順序（sequence）圖描述功能實(shí)現(xiàn)流程。對(duì)象設(shè)計(jì)應(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)約束。7.3對(duì)象（組件）的觸發(fā)機(jī)制規(guī)定對(duì)象（組件）中各個(gè)操作在什么外部條件觸發(fā)下被調(diào)用以及調(diào)用后的結(jié)果。7.4對(duì)象（組件）的關(guān)鍵算法如果對(duì)象（組件）中涉及關(guān)鍵算法，如采用何種算法加密、何種算法搜索等，篇三：軟件項(xiàng)目開發(fā)的文檔編寫標(biāo)準(zhǔn)化軟件項(xiàng)目開發(fā)的文檔編寫標(biāo)準(zhǔn)化在項(xiàng)目開發(fā)過程中，應(yīng)該按要求編寫好十三種文檔，文檔編制要求具有針對(duì)性、精確性、清晰性、完整性、靈活性、可追溯性。

可行性分析報(bào)告：說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會(huì)因素上的可行性，評(píng)述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案，說明并論證所選定實(shí)施方案的理由。

項(xiàng)目開發(fā)計(jì)劃：為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃，應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。

軟件需求說明書(軟件規(guī)格說明書)：對(duì)所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。它是在用戶與開發(fā)人員雙方對(duì)軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的，也是實(shí)施開發(fā)工作的基礎(chǔ)。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求，為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。

概要設(shè)計(jì)說明書：該說明書是概要實(shí)際階段的工作成果，它應(yīng)說明功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等，為詳細(xì)設(shè)計(jì)提供基礎(chǔ)。

詳細(xì)設(shè)計(jì)說明書：著重描述每一模塊是怎樣實(shí)現(xiàn)的，包括實(shí)現(xiàn)算法、邏輯流程等。

用戶操作手冊(cè)：本手冊(cè)詳細(xì)描述軟件的功能、性能和用戶界面，使用戶對(duì)如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識(shí)，特別是操作方法的具體細(xì)節(jié)。

測(cè)試計(jì)劃：為做好集成測(cè)試和驗(yàn)收測(cè)試，需為如何組織測(cè)試制訂實(shí)施計(jì)劃。計(jì)劃應(yīng)包括測(cè)試的內(nèi)容、進(jìn)度、條件、人員、測(cè)試用例的選取原則、測(cè)試結(jié)果允許的偏差范圍等。

測(cè)試分析報(bào)告：測(cè)試工作完成以后，應(yīng)提交測(cè)試計(jì)劃執(zhí)行情況的說明，對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論意見。

開發(fā)進(jìn)度月報(bào)：該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告，報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等。

項(xiàng)目開發(fā)總結(jié)報(bào)告：軟件項(xiàng)目開發(fā)完成以后，應(yīng)與項(xiàng)目實(shí)施計(jì)劃對(duì)照，總結(jié)實(shí)際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力，此外，還需對(duì)開發(fā)工作做出評(píng)價(jià)，總結(jié)出經(jīng)驗(yàn)和教訓(xùn)。

軟件維護(hù)手冊(cè)：主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的說明，便于軟件的維護(hù)。

軟件問題報(bào)告：指出軟件問題的登記情況，如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等，為軟件修改提供準(zhǔn)備文檔。

軟件修改報(bào)告：軟件產(chǎn)品投入運(yùn)行以后，發(fā)現(xiàn)了需對(duì)其進(jìn)行修正、更改等問題，應(yīng)將存在的問題、修改的考慮以及修改的影響作出詳細(xì)的描述，提交審批。項(xiàng)目開發(fā)計(jì)劃1引言1.1編寫目的：闡明編寫可行性研究報(bào)告的目的，提出讀者對(duì)象1.2項(xiàng)目背景：應(yīng)包括●項(xiàng)目的委托單位、開發(fā)單位和主管部門；●該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。1.3定義：列出文檔中用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文1.4參考資料：可包括●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文●文檔所引用的資料、規(guī)范等●列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源；2項(xiàng)目概述2.1工作內(nèi)容：簡(jiǎn)要說明項(xiàng)目的各項(xiàng)主要工作，介紹所開發(fā)軟件的功能、性能等；若不編寫可行性研究報(bào)告；則應(yīng)在本節(jié)給出較詳細(xì)的介紹；2.2條件與限制：闡明為完成項(xiàng)目應(yīng)具備的條件、開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件。必要時(shí)還應(yīng)說明用戶及分合同承擔(dān)的工作、完成期限及其他條件與限制。2.3產(chǎn)品2.3.1程序：列出應(yīng)交付的程序名稱、使用的語(yǔ)言及存儲(chǔ)形式。2.3.2文檔：列出應(yīng)交付的文檔。2.4運(yùn)行環(huán)境：應(yīng)包括硬件環(huán)境、軟件環(huán)境。2.5服務(wù)：闡明開發(fā)單位可向用戶提供的服務(wù)。如人員培訓(xùn)、安裝、保修、維護(hù)和其他運(yùn)行支持。2.6驗(yàn)收標(biāo)準(zhǔn)3實(shí)施計(jì)劃3.1任務(wù)分解：任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。3.2進(jìn)度：按階段完成的項(xiàng)目，用圖表說明開始時(shí)間、完成時(shí)間。3.3預(yù)算3.4關(guān)鍵問題：說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件、技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，并說明對(duì)策。4人員組織及分工5交付期限6專題計(jì)劃要點(diǎn)如測(cè)試計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、人員培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等。軟件需求說明書1引言1.1編寫目的：闡明編寫需求說明書的目的，指明讀者對(duì)象。1.2項(xiàng)目背景：應(yīng)包括●項(xiàng)目的委托單位、開心單位和主管部門；●該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。1.3定義：列出文檔中所用到的專門術(shù)語(yǔ)的定義和縮寫詞的原文。1.4參考資料：可包括●項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同或上級(jí)機(jī)關(guān)的批文●