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