軟件開(kāi)發(fā)文檔說(shuō)明(完整流程)(共10頁(yè))

1、精選優(yōu)質(zhì)文檔-傾情為你奉上在軟件行業(yè)有一句話(huà)：一個(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ū)的編制目的的就是為了使

2、用戶(hù)和軟件開(kāi)發(fā)者雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解、并使之面成為整個(gè)開(kāi)發(fā)工作的基礎(chǔ)。其格式要求如下：1引言11編寫(xiě)目的。 12背景13定義2任務(wù)概述21目標(biāo)22用戶(hù)的特點(diǎn)23假定和約束3需求規(guī)定31對(duì)功能的規(guī)定32對(duì)性能的規(guī)定321精度322時(shí)間特性的需求323靈活性33輸入輸出要求34數(shù)據(jù)管理能力要求35故障處理要求36其他專(zhuān)門(mén)要求4運(yùn)行環(huán)境規(guī)定41設(shè)備42支持軟件43接口44控制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ì)

3、和出錯(cuò)處理設(shè)計(jì)等，為程序的詳細(xì)設(shè)計(jì)提供基礎(chǔ)。其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2總體設(shè)計(jì)21需求規(guī)定22運(yùn)行環(huán)境23基本設(shè)計(jì)概念和處理流程24結(jié)構(gòu)25功能需求與程序的關(guān)系26人工處理過(guò)程27尚未解決的問(wèn)題3接口設(shè)計(jì)31用戶(hù)接口32外部接口3.。3內(nèi)部接口4運(yùn)行設(shè)計(jì)41運(yùn)行模塊的組合42運(yùn)行控制43運(yùn)行時(shí)間5系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)51邏輯結(jié)構(gòu)設(shè)計(jì)要點(diǎn)52物理結(jié)構(gòu)設(shè)計(jì)要求53數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系6系統(tǒng)出錯(cuò)處理設(shè)計(jì)61出錯(cuò)信息62補(bǔ)救措施63系統(tǒng)維護(hù)設(shè)計(jì)。 3.詳細(xì)設(shè)計(jì)文檔：主要是把我們每個(gè)小模塊，小功能的業(yè)務(wù)邏輯處理用文字的方式表達(dá)出來(lái)，讓程序員在編碼的時(shí)候有一個(gè)依據(jù)和參照；

4、同時(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引言11編寫(xiě)目的12背景13定義14參考資料2程序設(shè)計(jì)系統(tǒng)的結(jié)構(gòu)3程序1設(shè)計(jì)說(shuō)明31程序描述32功能33性能34輸入項(xiàng)35輸出項(xiàng)36算法37流程邏輯38接口39存儲(chǔ)分配310注釋設(shè)計(jì)311限制條件312測(cè)試計(jì)劃313尚未解決的問(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ā)卷宗。 1.可行性研究報(bào)告：編寫(xiě)目

5、的是，說(shuō)明該軟件開(kāi)發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)、經(jīng)濟(jì)和社會(huì)條件方面的可行性：評(píng)述為了合理達(dá)到開(kāi)發(fā)目標(biāo)而可能選擇的各種方案；說(shuō)明并論證所選定的方案。 其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2可行性研究的前提21要求22目標(biāo)23條件、假定和限制24進(jìn)行可行性研究的方法25評(píng)價(jià)尺度3對(duì)現(xiàn)有系統(tǒng)的分析31處理流程和數(shù)據(jù)流程32工作負(fù)荷33費(fèi)用開(kāi)支34人員35設(shè)備36局限性4所建議的系統(tǒng)41對(duì)所建議系統(tǒng)的說(shuō)明42處理流程和數(shù)據(jù)流程43改進(jìn)之處44影響441結(jié)設(shè)備的影響442對(duì)軟件的影響443對(duì)用戶(hù)單位機(jī)構(gòu)的影響444對(duì)系統(tǒng)運(yùn)行過(guò)程的影響445對(duì)開(kāi)發(fā)的影響446對(duì)地點(diǎn)和設(shè)備的影響447對(duì)經(jīng)費(fèi)

6、開(kāi)支的影響 45局限性 46技術(shù)條件方面的可行性5可選擇的其他系統(tǒng)的可行性51可選擇的系統(tǒng)方案152可選擇的系統(tǒng)方案26投資及效益分析61支出611基本建設(shè)投資612其他一次性支出613非一次性支出62收益621一次性收益622非一次性收益623不可定量的收益63收益投資比64投資回收周期65敏感性分析7社會(huì)因素方面的可行性71法律方面的可行性72使用方面的可行性8結(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ù)算、所需的軟硬條件等

7、問(wèn)題做出的安排記載下來(lái)，以便根據(jù)本計(jì)劃開(kāi)展和檢查項(xiàng)目的開(kāi)發(fā)工作。 其格式要求如下：1引言11編寫(xiě)目的12定義13參考資料2項(xiàng)目概述21工作內(nèi)容22主要參加人員23產(chǎn)品231程序232方件233服務(wù)234非移交的產(chǎn)品24驗(yàn)收標(biāo)準(zhǔn)25完成項(xiàng)目的最遲期限26本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期3實(shí)施計(jì)劃31工作任務(wù)的分配與人員分工32接口人員33進(jìn)度34預(yù)算35關(guān)鍵問(wèn)題4支持條件41計(jì)算機(jī)系統(tǒng)支持42需收用戶(hù)承擔(dān)的工作43由外單位提供的條件5專(zhuān)題計(jì)劃要點(diǎ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ě)

8、的。如果被開(kāi)發(fā)的軟件系統(tǒng)規(guī)模比較大，整個(gè)工程項(xiàng)目被劃分給若干個(gè)分項(xiàng)目駔承擔(dān)，開(kāi)發(fā)進(jìn)度月報(bào)將以分項(xiàng)目為單位摟月編寫(xiě)。 其格式要求如下：1標(biāo)題2工程進(jìn)度與狀態(tài)21進(jìn)度22狀態(tài)3資源耗用與狀態(tài)31資源耗用311工時(shí)313機(jī)時(shí)32狀態(tài)4經(jīng)費(fèi)支出與狀態(tài)41經(jīng)費(fèi)支出411支持性費(fèi)用412設(shè)備購(gòu)置費(fèi)42狀態(tài)5下一個(gè)月的工作計(jì)劃6建議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)

9、價(jià)。 其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2實(shí)際開(kāi)以結(jié)果21產(chǎn)品22主要功能和性能23基本流程24進(jìn)度25費(fèi)用3開(kāi)發(fā)工作評(píng)價(jià)31對(duì)生產(chǎn)效率的評(píng)價(jià)32對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià)33對(duì)技術(shù)方法的評(píng)價(jià)34出錯(cuò)原因的分析4經(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)題2模塊開(kāi)發(fā)情況表：其中模塊開(kāi)發(fā)情況表的格式如下表：模塊標(biāo)識(shí)符模塊的描述性名稱(chēng)代

10、碼設(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í)際）目際模塊大小（預(yù)計(jì)實(shí)際）項(xiàng)目負(fù)責(zé)人批準(zhǔn)(日期/簽字)3功能說(shuō)明4設(shè)計(jì)說(shuō)明5源代碼清單6測(cè)試說(shuō)明7復(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.

11、詳細(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ù)。其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2計(jì)劃21軟件說(shuō)明22測(cè)試內(nèi)容23測(cè)試231進(jìn)度安排232條件233測(cè)試資料234測(cè)試培訓(xùn)24測(cè)試3測(cè)試設(shè)計(jì)說(shuō)明31測(cè)試311控制312輸入313輸出314過(guò)程32測(cè)試

12、4評(píng)價(jià)準(zhǔn)則41范圍42數(shù)據(jù)整理43尺度4.測(cè)試分析報(bào)告：測(cè)試工作完成以后，應(yīng)當(dāng)提交測(cè)試計(jì)劃情況說(shuō)明書(shū)，對(duì)測(cè)試結(jié)果加以分析，并提出測(cè)試的結(jié)論性意見(jiàn)。其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2測(cè)試概要3測(cè)試結(jié)果及發(fā)現(xiàn)31測(cè)試132測(cè)試24對(duì)軟件功能的結(jié)論41功能1411能力412限制42功能25分析摘要51能力52缺陷和限制53建議54評(píng)價(jià)6測(cè)試資源消耗四、用戶(hù)文檔：用戶(hù)手冊(cè)、操作手冊(cè)。1.用戶(hù)手冊(cè)：用戶(hù)手冊(cè)的編制是要使用非專(zhuān)門(mén)術(shù)語(yǔ)的語(yǔ)言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法，使用戶(hù)（或潛在用戶(hù)）通過(guò)本手冊(cè)能夠了解該軟件的用途，并且能夠確定在什么情況下，如何使用它

13、。其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2用途21功能22性能221精度222時(shí)間特性223靈活性23安全保密3運(yùn)行環(huán)境31硬設(shè)備32支持軟件33數(shù)據(jù)結(jié)構(gòu)4使用過(guò)程41安裝與初始化42輸入421輸入數(shù)據(jù)的現(xiàn)實(shí)背景422輸入格式423輸入舉例43輸出431輸出數(shù)據(jù)的現(xiàn)實(shí)背景432輸出格式433輸出舉例44文卷查詢(xún)45出錯(cuò)處理和恢復(fù)46終端操作2.操作手冊(cè)：操作手冊(cè)的編制是為了向操作人員提供該軟件每一個(gè)運(yùn)行的具體過(guò)程和有關(guān)知識(shí)，包括操作方法的細(xì)節(jié)。其格式要求如下：1引言11編寫(xiě)目的12背景13定義14參考資料2軟件征述21軟件的結(jié)構(gòu)22程序表23文卷表3安裝與初始化4運(yùn)行說(shuō)明41運(yùn)行表42運(yùn)行步驟43運(yùn)行1431運(yùn)行控制432操作控制433輸入輸出文卷434輸出文段435輸出文段的復(fù)制436恢復(fù)過(guò)程44運(yùn)行2.5非常規(guī)過(guò)程6遠(yuǎn)程操作3.維護(hù)建議：軟件產(chǎn)品投入運(yùn)行之后，可能有修改、更正等問(wèn)題。應(yīng)當(dāng)對(duì)存在的問(wèn)題、修改的考慮以及修改的影響估計(jì)等作詳細(xì)的