軟體工程之文件篇(各文件的巨集觀把控)
一、可行性研究報告
第一部分:引言(背景,編寫目的)
第二部分:前提(目標,要求,方法,評價)
第三部分:現有系統分析(處理流程、工作負荷、開支、人員)
第四部分:建議模組分析(處理流程、改進之處,各方面影響、侷限性、技術可行性)
第五部分:可選擇的其他方案
第六部分:投資與效益分析(投入與產出)
第七部分:法律可行性、使用方面可行性
第八 部分:結論(是否可行)
綜述:
該軟體開發專案的實現在技術上、經濟上和社會因素上的可行性,評述為了合理的達到開發目標可供選擇的各種可能實施方案,說明並論證所選定實施方案的理由。
二、專案開發計劃
第一部分:引言(目的,背景,定義,參考資料)
第二部分:專案概述(工作內容,參與人員,產品,驗收標準,完工最遲期限,計劃批准日期)
第三部分:實施計劃(工作任務分工,介面人員,進度,預算)
第四部分:支援條件(計算機,使用者,外界支援)
第五部分:專題計劃要點
綜述:
為軟體專案實施方案制定出具體計劃,應該包括各部分工作的負責人員、開發的進度、開發經費的預算、所需的硬體及軟體資源等。
三、軟體需求說明書
第一部分:引言(目的,背景,定義,參考資料)
第二部分:任務概述(目標,使用者特點)
第三部分:需求規定(功能,效能,輸入輸出,資料管理,故障處理)
第四部分:執行環境規定(裝置,支援軟體,介面)
綜述:
對所開發軟體的功能、效能、使用者介面及執行環境等作出詳細的說明。它是在使用者與開發人員雙方對軟體需求取得共同理解並達成協議的條件下編寫的, 也是實施開發工作的基礎。該說明書應給出資料邏輯和資料採集的各項要求,為生成和維護系統資料檔案做好準備。
四、概要設計說明書
第一部分:引言(目的,背景,定義,參考)
第二部分:總體設計(需求規定,執行環境,基本概念,處理流程,結構,人工處理過程)
第三部分:介面設計(使用者介面,外部介面,內部介面)
第四部分:執行設計(執行模組組合,執行控制,執行時間)
第五部分:系統資料結構設計(邏輯結構設計,物理結構設計,資料結構與程式關係)
第六部分:系統出錯處理設計(出錯資訊,補救措施,系統維護設計)
該說明書是概要實際階段的工作成果,它應說明功能分配、模組劃分、程式的總體結構、輸入輸出以及介面設計、執行設計、資料結構設計和出錯處理設計等,為詳細設計提供基礎。
五、詳細設計說明書
第一部分:引言(目的,背景,定義,參考)
第二部分:程式系統結構
第三部分:程式設計說明(程式描述,功能,效能,輸入項,輸出項,演算法,流程邏輯,介面,儲存分配,註釋設計,測試計劃)
綜述:
注重描述每一模組是怎樣實現的,包括實現演算法、邏輯流程等。
六、測試計劃
第一部分:引言(目的,背景,定義,參考)
第二部分:計劃(軟體說明,測試內容,測試項(進度安排,條件,測試資料,測試培訓))
第三部分:測試設計說明(測試項(控制,輸入,輸出,過程))
第四部分:評價準則(範圍,資料整理,尺度)
綜述:
為做好整合測試和驗收測試,需為如何組織測試製定實施計劃。計劃應包含測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差範圍等。
七、測試分析報告
第一部分:引言(目的,背景,定義,參考)
第二部分:測試概要
第三部分:測試結果及發現(各階段測試(測試專案,測試要求,結果,發展))
第四部分:對軟體功能的結論(各階段結論(能力,限制))
第五部分:分析摘要(能力,缺陷限制,建議,評價)
第六部分:測試資源消耗
綜述:
測試工作完成以後,應提交測試計劃執行情況的說明,對測試結果加以分析,並提出測試的結論意見。
八、開發進度月報
該月報軟體人員按月向管理部門提交的專案進展情況報告,報告應包含進度計劃於實際執行情況的比較、階段成果、遇到的問題和解決問題的辦法以及下個月的打算等等。
九、專案開發總結報告
第一部分:引言(目的,背景,定義,參考)
第二部分:實際開發結果(產品,主要功能效能,基本流程,進度,費用)
第三部分:開發工作評價(生產效率,產品質量,技術方法,出錯原因的評價)
第四部分:經驗與教訓
綜述:
軟體專案開發完以後,應與專案實施計劃對照,總結實際執行的情況,如進度、成果、資源利用、成本和投入的人力,此外,還需對開發工作作出評價,總結出經驗和教訓。