軟件開發(fā)文檔說明書書(完整流程)

實用標(biāo)準(zhǔn)在軟件行業(yè)有一句話：一個軟件能否順利的完成并且功能是否完善， 重要是看這個軟件有多少文檔，軟件開發(fā)文檔是一個軟件的支柱， 如果你的開發(fā)文檔漏洞百出，那么你所開發(fā)出來的軟件也不可能會好； 開發(fā)文檔的好壞可以直接影響到所開發(fā)出來軟件的成功與否。一、軟件開發(fā)設(shè)計文檔：軟件開發(fā)文檔包括軟件需求說明書、數(shù)據(jù)要求說有書、概要設(shè)計說明書、詳細(xì)設(shè)計說明書。1、軟件需求說明書：也稱為軟件規(guī)格說明。 該說明書對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等做出詳細(xì)的說明。它是用戶與開發(fā)人員雙方對軟件需求取得共同理 解基礎(chǔ)上達(dá)成的協(xié)議，也是實施開發(fā)工作的基礎(chǔ)。軟件需求說明書的編制目的的就是 為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個共同的理解、并使之面成為 整個開發(fā)工作的基礎(chǔ)。其格式要求如下：引言1．1編寫目的。1．2背景1．3定義任務(wù)概述2．1目標(biāo)2．2用戶的特點2．3假定和約束文案大全實用標(biāo)準(zhǔn)需求規(guī)定3．1對功能的規(guī)定3．2對性能的規(guī)定3．2．1精度3．2．2時間特性的需求3．2．3靈活性3．3輸入輸出要求3．4數(shù)據(jù)管理能力要求3．5故障處理要求3．6其他專門要求運行環(huán)境規(guī)定4．1設(shè)備4．2支持軟件4．3接口4．4控制2、概要設(shè)計說明書：又稱系統(tǒng)設(shè)計說明書，這里所說的系統(tǒng)是指程序系統(tǒng)。編制的目的是說明對程序系統(tǒng)的設(shè)計考慮， 包括程序系統(tǒng)的基本處理。流程、程序系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計。運河行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等，為程序的詳細(xì)設(shè)計提供基礎(chǔ)。文案大全實用標(biāo)準(zhǔn)其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料總體設(shè)計2．1需求規(guī)定2．2運行環(huán)境2．3基本設(shè)計概念和處理流程2．4結(jié)構(gòu)2．5功能需求與程序的關(guān)系2．6人工處理過程2．7尚未解決的問題接口設(shè)計3．1用戶接口3．2外部接口3.。3內(nèi)部接口運行設(shè)計4．1運行模塊的組合4．2運行控制4．3運行時間文案大全實用標(biāo)準(zhǔn)系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計5．1邏輯結(jié)構(gòu)設(shè)計要點5．2物理結(jié)構(gòu)設(shè)計要求5．3數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系系統(tǒng)出錯處理設(shè)計6．1出錯信息6．2補救措施6．3系統(tǒng)維護(hù)設(shè)計。3.詳細(xì)設(shè)計文檔：主要是把我們每個小模塊， 小功能的業(yè)務(wù)邏輯處理用文字的方式表達(dá)出來，讓程序員在編碼的時候有一個依據(jù)和參照； 同時，在進(jìn)行詳細(xì)文檔設(shè)計的時候，有的軟件公司也會根據(jù)不同的項目作出相應(yīng)的 《軟件開發(fā)代碼規(guī)范》性文檔，以保障我們所做工作的統(tǒng)一性。如果一個軟件系比較簡單，層次很少，本文件可以不單獨編寫，有關(guān)內(nèi)容合并入概要設(shè)計說明書。其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料文案大全實用標(biāo)準(zhǔn)程序設(shè)計系統(tǒng)的結(jié)構(gòu)程序1設(shè)計說明3．1程序描述3．2功能3．3性能3．4輸入項3．5輸出項3．6算法3．7流程邏輯3．8接口3．9存儲分配3．10注釋設(shè)計3．11限制條件3．12測試計劃3．13尚未解決的問題4程序2設(shè)計說明...二、軟件開發(fā)管理文檔：可行性研究報告、項目開發(fā)計劃、開發(fā)進(jìn)度月報、項目開發(fā)總結(jié)、模塊開發(fā)卷宗。文案大全實用標(biāo)準(zhǔn)1.可行性研究報告：編寫目的是，說明該軟件開發(fā)項目的實現(xiàn)在技術(shù)、經(jīng)濟和社會條件方面的可行性：評述為了合理達(dá)到開發(fā)目標(biāo)而可能選擇的各種方案； 說明并論證所選定的方案。其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料可行性研究的前提2．1要求2．2目標(biāo)2．3條件、假定和限制2．4進(jìn)行可行性研究的方法2．5評價尺度對現(xiàn)有系統(tǒng)的分析3．1處理流程和數(shù)據(jù)流程3．2工作負(fù)荷3．3費用開支3．4人員3．5設(shè)備3．6局限性文案大全實用標(biāo)準(zhǔn)所建議的系統(tǒng)4．1對所建議系統(tǒng)的說明4．2處理流程和數(shù)據(jù)流程4．3改進(jìn)之處4．4影響4．4．1結(jié)設(shè)備的影響4．4．2對軟件的影響4．4．3對用戶單位機構(gòu)的影響4．4．4對系統(tǒng)運行過程的影響4．4．5對開發(fā)的影響4．4．6對地點和設(shè)備的影響4．4．7對經(jīng)費開支的影響4．5局限性4．6技術(shù)條件方面的可行性可選擇的其他系統(tǒng)的可行性5．1可選擇的系統(tǒng)方案15．2可選擇的系統(tǒng)方案2投資及效益分析6．1支出6．1．1基本建設(shè)投資6．1．2其他一次性支出6．1．3非一次性支出文案大全實用標(biāo)準(zhǔn)6．2收益6．2．1一次性收益6．2．2非一次性收益6．2．3不可定量的收益6．3收益投資比6．4投資回收周期6．5敏感性分析社會因素方面的可行性7．1法律方面的可行性7．2使用方面的可行性結(jié)論2.項目開發(fā)計劃：是為軟件項目實施方案制定出的具體計劃。 項目開發(fā)計劃應(yīng)提前給管理部門，并作為開發(fā)階段評審的基礎(chǔ)。編制項目開發(fā)計劃的止的是用文件的形式，把對于在開發(fā)過程中各項工作的負(fù)責(zé)人員、開發(fā)進(jìn)度、所需經(jīng)費預(yù)算、所需的軟硬條件等問題做出的安排記載下來， 以便根據(jù)本計劃開展和檢查項目的開發(fā)工作。其格式要求如下：引言1．1編寫目的1．2定義1．3參考資料文案大全實用標(biāo)準(zhǔn)項目概述2．1工作內(nèi)容2．2主要參加人員2．3產(chǎn)品2．3．1程序2．3．2方件2．3．3服務(wù)2．3．4非移交的產(chǎn)品2．4驗收標(biāo)準(zhǔn)2．5完成項目的最遲期限2．6本計劃的批準(zhǔn)者和批準(zhǔn)日期實施計劃3．1工作任務(wù)的分配與人員分工3．2接口人員3．3進(jìn)度3．4預(yù)算3．5關(guān)鍵問題支持條件4．1計算機系統(tǒng)支持4．2需收用戶承擔(dān)的工作4．3由外單位提供的條件專題計劃要點文案大全實用標(biāo)準(zhǔn)3.開發(fā)進(jìn)度月報：開發(fā)進(jìn)度月報的編制目的是及時向有關(guān)部門匯報項目開發(fā)的進(jìn)度和情況，以便及時 發(fā)現(xiàn)和處理開發(fā)過程中出現(xiàn)的問題，一般開發(fā)進(jìn)度月報是以項目組單位每月編寫的。如果被開發(fā)的軟件系統(tǒng)規(guī)模比較大， 整個工程項目被劃分給若干個分項目駔承擔(dān)，開發(fā)進(jìn)度月報將以分項目為單位摟月編寫。 其格式要求如下：標(biāo)題工程進(jìn)度與狀態(tài)2．1進(jìn)度2．2狀態(tài)資源耗用與狀態(tài)3．1資源耗用3．1．1工時3．1．3機時3．2狀態(tài)經(jīng)費支出與狀態(tài)4．1經(jīng)費支出4．1．1支持性費用4．1．2設(shè)備購置費4．2狀態(tài)下一個月的工作計劃建議文案大全實用標(biāo)準(zhǔn)4.項目開發(fā)總結(jié)：軟件項目開發(fā)完成之后，應(yīng)當(dāng)與項目實施計劃對照，總結(jié)實際執(zhí)行的情況，如進(jìn)度、 成果、資源利用、成本和投入的人力。此外，還需對開發(fā)工作做出評價，總結(jié)經(jīng)驗和教訓(xùn)。項目開發(fā)總結(jié)報告的編制是為了總結(jié)本項目開發(fā)工作的經(jīng)驗，說明實際取得的開發(fā)結(jié)果以及對整個開發(fā)工作的各個方面的評價。其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料實際開以結(jié)果2．1產(chǎn)品2．2主要功能和性能2．3基本流程2．4進(jìn)度2．5費用開發(fā)工作評價3．1對生產(chǎn)效率的評價文案大全實用標(biāo)準(zhǔn)3．2對產(chǎn)品質(zhì)量的評價3．3對技術(shù)方法的評價3．4出錯原因的分析經(jīng)驗與教訓(xùn)5.模塊開發(fā)卷宗：模塊開發(fā)卷宗是在模塊開發(fā)過程中逐步編寫出來的， 每完成一個模塊或一組密切相關(guān)的模塊的復(fù)制進(jìn)編寫一份， 應(yīng)該把所有的模塊開發(fā)卷宗匯集在一起。編寫的目的是記錄和匯意低層次開發(fā)的進(jìn)度和結(jié)果， 經(jīng)便于對整個模塊開發(fā)工作的管理和復(fù)審，并為將來的維護(hù)提供非常有用的技術(shù)信息。 1標(biāo)題模塊開發(fā)情況表：其中模塊開發(fā)情況表的格式如下表：模塊標(biāo)識符模塊的描述性名稱代碼設(shè)計（計劃開始日期 實際開始日期）模塊測試（計劃開始日期 實際開始日期）組裝測試（計劃開始日期 實際開始日期）代碼復(fù)查(日期/簽字)源代碼行數(shù)（預(yù)計 /實際）目際模塊大?。A(yù)計 實際）項目負(fù)責(zé)人批準(zhǔn) (日期/簽字)文案大全實用標(biāo)準(zhǔn)功能說明設(shè)計說明源代碼清單測試說明復(fù)審的結(jié)論三、軟件開發(fā)測試文檔：概要測試計劃、詳細(xì)測試計劃、測試實施計劃、測試分析報告。1.概要測試計劃：是軟件項目實施計劃中的一項重要的內(nèi)容， 應(yīng)當(dāng)在軟件開發(fā)初期、即需求分析階段制訂。項計劃應(yīng)當(dāng)定義被測試對象和測試目標(biāo)， 確定測試階段和測試周期的劃分；制訂測 試人員、軟硬件資源和測試進(jìn)度等方面的計劃，規(guī)定軟件測試方法，測試標(biāo)準(zhǔn)以及支持環(huán)境和測試工具。2.詳細(xì)測試計劃：是針對子系統(tǒng)在特定的測試階段所要進(jìn)行的測試工作制訂詳細(xì)計劃，它詳細(xì)說明規(guī)定了測試小組的各項測試任務(wù)， 測試策略、任務(wù)分配和進(jìn)度安排等。3.測試實施計劃：測試人員的測試實施計劃是根據(jù)詳細(xì)計劃制訂的測試者的測試具體實施計劃。它規(guī)定了測試者在每一輪測試中負(fù)責(zé)測試的內(nèi)容， 測試強度和工作進(jìn)度等。測試實施計劃是整個軟件測試的組成部分， 是檢查測試實際執(zhí)行情況的重要依據(jù)。文案大全實用標(biāo)準(zhǔn)其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料計劃2．1軟件說明2．2測試內(nèi)容2．3測試2．3．1進(jìn)度安排2．3．2條件2．3．3測試資料2．3．4測試培訓(xùn)2．4測試測試設(shè)計說明3．1測試3．1．1控制3．1．2輸入3．1．3輸出3．1．4過程3．2測試文案大全實用標(biāo)準(zhǔn)評價準(zhǔn)則4．1范圍4．2數(shù)據(jù)整理4．3尺度4.測試分析報告：測試工作完成以后，應(yīng)當(dāng)提交測試計劃情況說明書，對測試結(jié)果加以分析，并提 出測試的結(jié)論性意見。其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料測試概要測試結(jié)果及發(fā)現(xiàn)3．1測試13．2測試2對軟件功能的結(jié)論4．1功能14．1．1能力4．1．2限制4．2功能2文案大全實用標(biāo)準(zhǔn)分析摘要5．1能力5．2缺陷和限制5．3建議5．4評價測試資源消耗四、用戶文檔：用戶手冊、操作手冊。1.用戶手冊：用戶手冊的編制是要使用非專門術(shù)語的語言， 充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法， 使用戶（或潛在用戶）通過本手冊能夠了解該軟件的用途，并且能夠確定在什么情況下，如何使用它。其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料用途文案大全實用標(biāo)準(zhǔn)2．1功能2．2性能2．2．1精度2．2．2時間特性2．2．3靈活性2．3安全保密運行環(huán)境3．1硬設(shè)備3．2支持軟件3．3數(shù)據(jù)結(jié)構(gòu)使用過程4．1安裝與初始化4．2輸入4．2．1輸入數(shù)據(jù)的現(xiàn)實背景4．2．2輸入格式4．2．3輸入舉例4．3輸出4．3．1輸出數(shù)據(jù)的現(xiàn)實背景4．3．2輸出格式4．3．3輸出舉例4．4文卷查詢4．5出錯處理和恢復(fù)文案大全實用標(biāo)準(zhǔn)4．6終端操作2.操作手冊：操作手冊的編制是為了向操作人員提供該軟件每一個運行的具體過程和有關(guān)知識，包括操作方法的細(xì)節(jié)。其格式要求如下：引言1．1編寫目的1．2背景1．3定義1．4參考資料軟件征述2．1軟件的結(jié)構(gòu)2．2程序表2．3文卷表安裝與初始化運行說明4．1運行表4．2運行步驟4．3運行14．3．1運行控制4．3．2操作控制文案大全實用標(biāo)準(zhǔn)4．3．3輸入輸出文卷4．3．4輸出文段4．3．5輸出文段的復(fù)制4．3．6恢復(fù)過程4．4運行2...非常規(guī)過程遠(yuǎn)程操作3.維護(hù)建議：軟件產(chǎn)品投入運行之后，可能有修改、更正等問題。應(yīng)當(dāng)對存在的問題、修改的考慮以及修改的影響估計等