軟件設計開發(fā)規(guī)范

軟件設計開發(fā)規(guī)范篇一：軟件開發(fā)規(guī)范軟件開發(fā)規(guī)范軟件開發(fā)行為規(guī)范(第一版）為了把公司已經(jīng)發(fā)布的軟件開發(fā)過程規(guī)范有效地運作于產(chǎn)品開發(fā)活動中，把各種規(guī)范“逐步形成工程師的作業(yè)規(guī)范”，特制定本軟件開發(fā)行為規(guī)范，以達到過程控制的目的。與軟件開發(fā)相關(guān)的所有人員，包括各級經(jīng)理和工程師都必須遵守本軟件開發(fā)行為規(guī)范。對違反規(guī)范的開發(fā)行為，必須按照有關(guān)管理規(guī)定進行處罰。本軟件開發(fā)行為規(guī)范的內(nèi)容包括：軟件需求分析、軟件項目計劃、概要設計、詳細設計、編碼、需求管理、配置管理、軟件質(zhì)量保證、數(shù)據(jù)度量和分析等。本軟件開發(fā)行為規(guī)范，采用以下的術(shù)語描述：★規(guī)則★建議★說明：對此規(guī)則或建議進行必要的解釋?！锸纠簩Υ艘?guī)則或建議從正或反兩個方面給出例子。本軟件開發(fā)過程行為規(guī)范由研究技術(shù)管理處負責解釋和維護。目錄1軟件需求分析2軟件項目計劃3概要設計4詳細設計5編碼6需求管理7軟件配置管理8軟件質(zhì)量保證9數(shù)據(jù)度量和分析僅供內(nèi)部使用359111418192123251軟件需求分析1-1：軟件需求分析必須在產(chǎn)品需求規(guī)格的基礎上進行，并保證完全實現(xiàn)產(chǎn)品需求規(guī)格的定義。1-2：當產(chǎn)品的需求規(guī)格發(fā)生變更時，必須修訂軟件需求規(guī)格文檔。軟件需求規(guī)格的變更必須經(jīng)過評審，并保存評審記錄。1-3：必須對軟件需求規(guī)格文檔進行正規(guī)檢視。1-4：軟件需求分析過程活動結(jié)束前，必須經(jīng)過評審，并保存評審記錄。1-5：在對軟件需求規(guī)格文檔的正規(guī)檢視或評審時，必須檢查軟件需求規(guī)格文檔中需求的清晰性、完備性、兼容性、一致性、正確性、可行性、易修改性、健壯性、易追溯性、易理解性、易測試性和可驗證性、性能、功能、接口、數(shù)據(jù)、可維護性等內(nèi)容。說明：參考建議1-1到1-16。1-1：采用以下檢查表檢查軟件需求規(guī)格文檔中需求的清晰性。1-2：采用以下檢查表檢查軟件需求規(guī)格文檔中需求的完備性。僅供內(nèi)部使用41-3：采用以下檢查表檢查軟件需求規(guī)格文檔中需求的兼容性。1-4：采用以下檢查表檢查軟件需求規(guī)格文檔中需求的一致性。1-5：采用以下檢查表檢查軟件需求規(guī)格文檔中需求的正確性。1-6：采用以下檢查表檢查軟件需求規(guī)格文檔中需求的可行性。僅供內(nèi)部使用5篇二：軟件設計文檔國家標準GB8567軟件設計文檔國家標準GB8567-88一、文檔編寫標準化在整個項目開發(fā)及使用過程中，應該有完備的文檔支持，文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性和可追溯性。完備的文檔對軟件的開發(fā)及使用起了很大的作用。一般要求編寫好十三種文檔。1、可行性分析報告說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)上、經(jīng)濟上和社會因素上的可行性，評述為了合理地達到開發(fā)目標可供選擇的各種可能實施方案，說明并論證所選定實施方案的理由。2、項目開發(fā)計劃為軟件項目實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開發(fā)的進度、開發(fā)經(jīng)費的預算、所需的硬件及軟件資源等。3、軟件需求說明書（軟件規(guī)格說明書）對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。它是在用戶與開發(fā)人員雙方對軟件需求取得共同理解并達成協(xié)議的條件下編寫的，也是實施開發(fā)工作的基礎。該說明書應給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項要求，為生成和維護系統(tǒng)數(shù)據(jù)文件做好準備。4、概要設計說明書是概要設計階段的工作總結(jié)。主要包括功能分配、模塊劃分、程序總體結(jié)構(gòu)、輸入輸出以及接口設計、運行設計、數(shù)據(jù)結(jié)構(gòu)設計和出錯處理等，為詳細設計作好準備。5、詳細設計說明書著重描述每一模塊是怎樣實現(xiàn)的，包括實現(xiàn)算法、邏輯流程等。6、用戶操作手冊詳細描述了該軟件的功能、性能和用戶界面，使用該軟件的具體方法等。7、測試計劃包括測試內(nèi)容、進度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。8、測試分析報告測試計劃的執(zhí)行情況，對測試結(jié)果的分析，提出測試結(jié)論。9、開發(fā)進度月報按月提交的項目進展情況報告。包括計劃與實際執(zhí)行情況的對比、階段成果、遇到的問題、解決的方法以及下一步的打算。10、項目開發(fā)總結(jié)報告項目完成以后，總結(jié)實際執(zhí)行情況。如進度、成果、資源利用、成本和投入的人力，對項目開發(fā)作出評價，總結(jié)經(jīng)驗與教訓。11、軟件維護手冊主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件說明、維護過程說明等。12、軟件問題報告記錄軟件出現(xiàn)問題的日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等，為軟件修改提供準備文檔。13、軟件修改報告軟件產(chǎn)品投入使用后，發(fā)現(xiàn)了需修改、更正的問題，要將出現(xiàn)的問題、修改意見、修改可能出現(xiàn)影響作出詳細描述，提交審批。二、可行性分析報告的撰寫要求可行性研究報告的編寫內(nèi)容要求如下：1引言1．1編寫目的說明編寫本可行性研究報告的目的，指出預期的讀者。1．2背景說明：a．所建議開發(fā)的軟件系統(tǒng)的名稱；b．本項目的任務提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡；C．該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關(guān)系。1．3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1．4參考資料列出用得著的參考資料，如：a．本項目的經(jīng)核準的計劃任務書或合同、上級機關(guān)的批文；b．屬于本項目的其他已發(fā)表的文件；C．本文件中各處引用的文件、資料，包括所需用到的軟件開發(fā)標準。|列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2可行性研究的前提說明對所建議的開發(fā)項目進行可行性研究的前提，如要求、目標、假定、限制等。2．1要求說明對所建議開發(fā)的軟件的基本要求，如：a．功能；b．性能；C．輸出如報告、文件或數(shù)據(jù)，對每項輸出要說明其特征，如用途、產(chǎn)生頻度、接口以及分發(fā)對象；d．輸入說明系統(tǒng)的輸入，包括數(shù)據(jù)的來源、類型、數(shù)量、數(shù)據(jù)的組織以及提供的頻度；e．處理流程和數(shù)據(jù)流程用圖表的方式表示出最基本的數(shù)據(jù)流程和處理流程，并輔之以敘述；f．在安全與保密方面的要求；g．同本系統(tǒng)相連接的其他系統(tǒng)；h．完成期限。2．2目標說明所建議系統(tǒng)的主要開發(fā)目標，如：a．人力與設備費用的減少；b．處理速度的提高；C．控制精度或生產(chǎn)能力的提高；d．管理信息服務的改進；e．自動決策系統(tǒng)的改進；f．人員利用率的改進。2．3條件、假定和限制說明對這項開發(fā)中給出的條件、假定和所受到的限制，如：a．所建議系統(tǒng)的運行壽命的最小值；b．進行系統(tǒng)方案選擇比較的時間；c．經(jīng)費、投資方面的來源和限制；d．法律和政策方面的限制；e．硬件、軟件、運行環(huán)境和開發(fā)環(huán)境方面的條件和限制；f．可利用的信息和資源；g．系統(tǒng)投入使用的最晚時間。2．4進行可行性研究的方法說明這項可行性研究將是如何進行的，所建議的系統(tǒng)將是如何評價的。摘要說明所使用的基本方法和策略，如調(diào)查、加權(quán)、確定模型、建立基準點或仿真等。2．5評價尺度說明對系統(tǒng)進行評價時所使用的主要尺度，如費用的多少、各項功能的優(yōu)先次序、開發(fā)時間的長短及使用中的難易程度。3對現(xiàn)有系統(tǒng)的分析這里的現(xiàn)有系統(tǒng)是指當前實際使用的系統(tǒng)，這個系統(tǒng)可能是計算機系統(tǒng)，也可能是一個機械系統(tǒng)甚至是一個人工系統(tǒng)。分析現(xiàn)有系統(tǒng)的目的是為了進一步闡明建議中的開發(fā)新系統(tǒng)或修改現(xiàn)有系統(tǒng)的必要性。3．1處理流程和數(shù)據(jù)流程說明現(xiàn)有系統(tǒng)的基本的處理流程和數(shù)據(jù)流程。此流程可用圖表即流程圖的形式表示，并加以敘述。3．2工作負荷列出現(xiàn)有系統(tǒng)所承擔的工作及工作量。3．3費用開支列出由于運行現(xiàn)有系統(tǒng)所引起的費用開支，如人力、設備、空間、支持性服務、材料等項開支以及開支總額。3．4人員列出為了現(xiàn)有系統(tǒng)的運行和維護所需要的人員的專業(yè)技術(shù)類別和數(shù)量。3．5設備列出現(xiàn)有系統(tǒng)所使用的各種設備。3．6局限性列出本系統(tǒng)的主要的局限性，例如處理時間趕不上需要，響應不及時，數(shù)據(jù)存儲能力不足，處理功能不夠等。并且要說明，為什么對現(xiàn)有系統(tǒng)的改進性維護已經(jīng)不能解決問題。4所建議的系統(tǒng)本章將用來說明所建議系統(tǒng)的目標和要求將如何被滿足。4．1對所建議系統(tǒng)的說明概括地說明所建議系統(tǒng)，并說明在第1．2章中列出的那些要求將如何得到滿足，說明所使用的基本方法及理論根據(jù)。4．2處理流程和數(shù)據(jù)流程給出所建議系統(tǒng)的處理流程和數(shù)據(jù)流程。4．3改進之處按2．2條中列出的目標，逐項說明所建議系統(tǒng)相對于現(xiàn)存系統(tǒng)具有的改進。4．4影響說明在建立所建議系統(tǒng)時，預期將帶來的影響，包括：4．4．1對設備的影響說明新提出的設備要求及對現(xiàn)存系統(tǒng)中尚可使用的設備須作出的修改。4．4．2對軟件的影響說明為了使現(xiàn)存的應用軟件和支持軟件能夠同所建議系統(tǒng)相適應。而需要對這些軟件所進行的修改和補充。4．4．3對用戶單位機構(gòu)的影響說明為了建立和運行所建議系統(tǒng)，對用戶單位機構(gòu)、人員的數(shù)量和技術(shù)水平等方面的全部要求。4．4．4對系統(tǒng)運行過程的影響說明所建議系統(tǒng)對運行過程的影響，如：a．用戶的操作規(guī)程；b．運行中心的操作規(guī)程；C．運行中心與用戶之間的關(guān)系；d．源數(shù)據(jù)的處理；e．數(shù)據(jù)進入系統(tǒng)的過程；f．對數(shù)據(jù)保存的要求，對數(shù)據(jù)存儲、恢復的處理；g．輸出報告的處理過程、存儲媒體和調(diào)度方法；h．系統(tǒng)失效的后果及恢復的處理辦法。4．4．5對開發(fā)的影響說明對開發(fā)的影響，如：a．為了支持所建議系統(tǒng)的開發(fā)，用戶需進行的工作；b．為了建立一個數(shù)據(jù)庫所要求的數(shù)據(jù)資源；C．為了開發(fā)和測驗所建議系統(tǒng)而需要的計算機資源；d．所涉及的保密與安全問題。4．4．6對地點和設施的影響說明對建筑物改造的要求及對環(huán)境設施的要求。4．4．7對經(jīng)費開支的影響扼要說明為了所建議系統(tǒng)的開發(fā)，設計和維持運行而需要的各項經(jīng)費開支。4．5局限性說明所建議系統(tǒng)尚存在的局限性以．及這些問題未能消除的原因。4．6技術(shù)條件方面的可行性本節(jié)應說明技術(shù)條件方面的可行性，如：a．在當前的限制條件下，該系統(tǒng)的功能目標能否達到；b．利用現(xiàn)有的技術(shù)，該系統(tǒng)的功能能否實現(xiàn)；C．對開發(fā)人員的數(shù)量和質(zhì)量的要求并說明這些要求能否滿足；d．在規(guī)定的期限內(nèi)，本系統(tǒng)的開發(fā)能否完成。5可選擇的其他系統(tǒng)方案扼要說明曾考慮過的每一種可選擇的系統(tǒng)方案，包括需開發(fā)的和可從國內(nèi)國外直接購買的，如果沒有供選擇的系統(tǒng)方案可考慮，則說明這一點。5．1可選擇的系統(tǒng)方案1參照第4章的提綱，說明可選擇的系統(tǒng)方案1，并說明它未被選中的理由。5．2可選擇的系統(tǒng)方案2按類似5．1條的方式說明第2個乃至第。個可選擇的系統(tǒng)方案。．．．．．．6投資及效益分析6．1支出對于所選擇的方案，說明所需的費用。如果已有一個現(xiàn)存系統(tǒng)，則包括該系統(tǒng)繼續(xù)運行期間所需的費用。6．1．1基本建設投資包括采購、開發(fā)和安裝下列各項所需的費用，如：a．房屋和設施；b．ADP設備；C．數(shù)據(jù)通訊設備；d．環(huán)境保護設備；e．安全與保密設備；f．ADP操作系統(tǒng)的和應用的軟件；g．數(shù)據(jù)庫管理軟件。6．1．2其他一次性支出包括下列各項所需的費用，如：a．研究（需求的研究和設計的研究）；b．開發(fā)計劃與測量基準的研究；C．數(shù)據(jù)庫的建立；d．ADP軟件的轉(zhuǎn)換；e．檢查費用和技術(shù)管理性費用；f．培訓費、旅差費以及開發(fā)安裝人員所需要的一次性支出；g．人員的退休及調(diào)動費用等。6．1．3非一次性支出列出在該系統(tǒng)生命期內(nèi)按月或按季或按年支出的用于運行和維護的費用，包括：a．設備的租金和維護費用；b軟件的租金和維護費用；C．數(shù)據(jù)通訊方面的租金和維護費用；d．人員的工資、獎金；e．房屋、空間的使用開支；f．公用設施方面的開支；g．保密安全方面的開支；h．其他經(jīng)常性的支出等。6．2收益對于所選擇的方案，說明能夠帶來的收益，這里所說的收益，表現(xiàn)為開支費用的減少或避免、差錯的減少、靈活性的增加、動作速度的提高和管理計劃方面的改進等，包括；6．2．1一次性收益說明能夠用人民幣數(shù)目表示的一次性收益，可按數(shù)據(jù)處理、用戶、管理和支持等項分類敘述，如：a．開支的縮減包括改進了的系統(tǒng)的運行所引起的開支縮減，如資源要求的減少，運行效率的改進，數(shù)據(jù)進入、存貯和恢復技術(shù)的改進，系統(tǒng)性能的可監(jiān)控，軟件的轉(zhuǎn)換和優(yōu)化，數(shù)據(jù)壓縮技術(shù)的采用，處理的集中化／分布化等；b．價值的增升包括由于一個應用系統(tǒng)的使用價值的增升所引起的收益，如資源利用的改進，管理和運行效率的改進以及出錯率的減少等；C．其他如從多余設備出售回收的收入等。篇三：軟件開發(fā)文檔規(guī)范附2:軟件文檔編寫向?qū)臋n分類項目包括如下幾類文檔：項目管理文檔。包括：《軟件項目計劃》、《項目進度報告》、《項目開發(fā)總結(jié)報告》軟件開發(fā)文檔。包括：《需求規(guī)格說明》、《概要設計說明》、《詳細設計說明》、《測試計劃》、《軟件測試分析報告》。產(chǎn)品文檔。包括：《用戶操作手冊》《演示文件》。軟件項目計劃（SoftwareProjectPlan）一．引言1．編寫目的（闡明編寫軟件計劃的目的，指出讀者對象。）2．項目背景（可包括：（1）項目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3．定義（列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。）4．參考資料（可包括：文檔所引用的資料、規(guī)范等；列出資料的、標題、編號、發(fā)表日期、出版單位或資料來源。）二．項目概述1.工作內(nèi)容（簡要說明項目的各項主要工作,介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報告,則應在本節(jié)給出較詳細的介紹。)2.條件與限制（闡明為完成項目應具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時還應說明用戶及分合同承包者承擔的工作完成期限及其它條件與限制。）3.產(chǎn)品（1）程序（列出應交付的程序名稱使用的語言及存儲形式。）（2）文檔（列出應交付的文檔。）（3）運行環(huán)境（應包括硬件環(huán)境軟件環(huán)境。）4．服務（闡明開發(fā)單位可向用戶提供的服務.如人員培訓安裝保修維護和其他運行支持。）5．驗收標準三．實施計劃1．任務分解（任務的劃分及各項任務的負責人。）2．進度（按階段完成的項目,用圖表說明開始時間完成時間。）3．預算4．關(guān)鍵問題（說明可能影響項目的關(guān)鍵問題,如設備條件技術(shù)難點或其他風險因素,并說明對策。）四．人員組織及分工五．交付期限六．專題計劃要點（如測試計劃等。）項目開發(fā)進度報告一．報告時間及所處的開發(fā)階段二．給出進度1．本周的主要活動2．實際進展與計劃比較三．所用工時（按不同層次人員分別計時。）四．所有機時五．工作遇到的問題及采取的對策六．本周完成的成果七．下周的工作計劃八．特殊問題項目開發(fā)總結(jié)報告一．引言1．編寫目的（闡明編寫總結(jié)報告的目的,指明讀者對象。）2．項目背景（說明項目的來源、委托單位、開發(fā)單位及主管部門。）3．定義（列出報告中用到的專門術(shù)語定義和縮寫詞的原意。）4．參考資料（列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源，可包括：（1）項目開發(fā)計劃；（2）需求規(guī)格說明書；（3）概要設計說明書；（4）詳細設計說明書；（5）用戶操作手冊；（6）測試計劃；（7）測試分析報告（8）本報告引用的其他資料、采用的開發(fā)標準或開發(fā)規(guī)范。）二．開發(fā)結(jié)果1．產(chǎn)品（可包括：（1）列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式；產(chǎn)品文檔名稱等。）2．主要功能及性能3．所用工時（按人員的不同層次分別計時。）4．所用機時5．進度（給出計劃進度與實際進度的對比。）三．評價1．生產(chǎn)率評價（如平均每人每周源程序行數(shù)、文檔的字數(shù)等。）2．技術(shù)方案評價3．產(chǎn)品質(zhì)量評價四．經(jīng)驗與教訓需求規(guī)格說明書（RequirementsSpecification）一．引言1．編寫目的（闡明編寫需求說明書的目的,指明讀者對象。）2．項目背景（可包括：（1）項目的委托單位,開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3．定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原文。）4．參考資料（可包括：（1）項目開發(fā)計劃；（2）文檔所引用的資料，標準和規(guī)范。列出這些資料的、標題、編號、發(fā)表日期、出版單位或資料來源。）二．任務概述1．目標2．運行環(huán)境3．條件與限制三．數(shù)據(jù)描述1．靜態(tài)數(shù)據(jù)2．動態(tài)數(shù)據(jù)（包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。）3．數(shù)據(jù)庫描述（給出使用數(shù)據(jù)庫的名稱和類型。）4．數(shù)據(jù)詞典5．數(shù)據(jù)采集四．功能需求1．功能劃分2．功能描述五．性能需求1．數(shù)據(jù)精確度2．時間特性（如響應時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)化與傳輸時間、運行時間等。）