一、文檔的重要性
文檔的作用:
①提高軟件開發的能件度。
②作爲檢查軟件開發進度和開發質量的依據,實現對軟件開發的工程管理。
③提高開發效率。
④作爲軟件開發人員的一定成果和結束標誌。
⑤便於以後的軟件開發、使用和維護。
⑥便於管理人員、開發人員、操作人員、用戶之間的協作。
⑦文檔的過程就是軟件開發的過程。文檔是軟件開發規範和指南。
二、文檔的階段
1.定義階段
(1)可行性研究報告
目的:在從技術、經濟、管理和開發環境等幾個方面,確定了一個軟件可以完成,需求方和開發商共同討論項目中的 開發方案。
預期讀者:軟件開發商、項目經理、分析員
(2)需求分析說明書
目的:寫出用戶對軟件的一些需求,明確軟件的功能和性能,能夠很清楚的指出開發人員需要做什麼等。
預期讀者:項目經理、開發人員、用戶
(3)數據要求說明書
目的:明確開發系統各項功能的實現時,對數據的要求,同時也爲概要設計和詳細設計階段提供參考,爲其他開發人員的閱讀提供便利。
預期讀者:項目經理、數據庫設計人員、開發人員、維護人員、測試人員
(4)用戶手冊
目的:爲了使用戶熟悉操作,給首次使用本軟件的用戶提供幫助,’ 使其能夠儘快的掌握本系統的操作。預期讀者:購買了此軟件的用戶
(5)項目開發計劃
目的:對開發機房收費系統的費用、時間、進度、人員配置、開發環境和運行環境的配置進行說明,未開發的下一步做準備。
預期讀者:項目經理、開發人員、分析員、用戶
(1)數據庫設計說明書
目的:根據數據要求說明書,數據庫設計人員設計相應的數據庫。
預期讀者:項目經理、開發人員、數據庫的設計人員
(2)概要設計說明書(設計軟件的結構)
目的:在需求分析基礎上得到的物理模型確定一個合理的軟件系統的體系結構。包括:系統的基本處理流程、程序系統的組織結構、模塊劃分、功能分配、接口設計、運行設計、數據結構設計和出錯處理設計等,爲程序的詳細設計提供基礎。
預期讀者:項目經理、設計人員、開發人員、測試人員
(3)詳細設計說明書(模塊功能的具體描述)
目的:在概要設計說明書的基礎上完成的,它更加仔細地清楚地描述模塊中的內容,功能實現寫的更加仔細。預期讀者:項目經理、開發人員、測試人員、維護人員等所有人員
(4)操作手冊
目的:提供軟件操作的步驟方法。
預期讀者:用戶
(5)測試計劃
目的:找到系統中的漏洞,並且設計出測試用例
預期讀者:項目經理、測試人員
(6)開發進度月表
目的:軟件開發了一段時間之後,對進度的總結,及時發現在開發過程中存在的問題,爲以後的開發提供經驗教訓,提高接下來項目的開發進度。
預期讀者:項目經理、開發人員
(7)測試分析報告
目的:對測試數據功能問題進行分析歸納記錄
預期讀者:項目經理、開發人員
目的:爲以後項目的開發提供寶貴的經驗,避免今後的項目中出現類似的問題,從而大大提高開發的效率。
預期讀者:項目經理、開發人員