軟件開(kāi)發(fā)文檔說(shuō)明書(shū)書(shū)(完整流程)

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