軟件開發(fā)需要的十三類文檔
在軟件項目開發(fā)過程中,應(yīng)該按軟件開發(fā)要求撰寫十三類文檔,文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性!
1、可行性分析報告
說明該軟件開發(fā)項目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性,評述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案,說明并論證所選定實(shí)施方案的理由。
2、項目開發(fā)計劃
為軟件項目實(shí)施方案制訂出具體計劃,應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等。
3、軟件需求說明書(軟件規(guī)格說明書)
對所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明。它是在用戶與開發(fā)人員雙方對軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的,也是實(shí)施開發(fā)工作的基礎(chǔ)。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項要求,為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備。
4、概要設(shè)計說明書
該說明書是概要實(shí)際階段的工作成果,它應(yīng)說明功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計、運(yùn)行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等,為詳細(xì)設(shè)計提供基礎(chǔ)。
5、詳細(xì)設(shè)計說明書
著重描述每一模塊是怎樣實(shí)現(xiàn)的,包括實(shí)現(xiàn)算法、邏輯流程等。
6、用戶操作手冊
本手冊詳細(xì)描述軟件的功能、性能和用戶界面,使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識,特別是操作方法的具體細(xì)節(jié)。
7、測試計劃
為做好集成測試和驗收測試,需為如何組織測試制訂實(shí)施計劃。計劃應(yīng)包括測試的內(nèi)容、進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。
8、測試分析報告
測試工作完成以后,應(yīng)提交測試計劃執(zhí)行情況的說明,對測試結(jié)果加以分析,并提出測試的結(jié)論意見。
9、開發(fā)進(jìn)度月報
該月報系軟件人員按月向管理部門提交的項目進(jìn)展情況報告,報告應(yīng)包括進(jìn)度計劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。
10、項目開發(fā)總結(jié)報告
軟件項目開發(fā)完成以后,應(yīng)與項目實(shí)施計劃對照,總結(jié)實(shí)際執(zhí)行的情況,如進(jìn)度、成果、資源利用、成本和投入的人力,此外,還需對開發(fā)工作做出評價,總結(jié)出經(jīng)驗和教訓(xùn)。
11、軟件維護(hù)手冊
主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的說明,便于軟件的維護(hù)。
12、軟件問題報告
指出軟件問題的登記情況,如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等,為軟件修改提供準(zhǔn)備文檔。
13、軟件修改報告
軟件產(chǎn)品投入運(yùn)行以后,發(fā)現(xiàn)了需對其進(jìn)行修正、更改等問題,應(yīng)將存在的問題、修改的考慮以及修改的影響作出詳細(xì)的描述,提交審批。
來源:http://www.cnblogs.com/mike-mei/p/8000417.html
想了解更多?現(xiàn)在就開始免費(fèi)體驗