軟件設計:文檔編寫標準化

字號:

在項目開發(fā)過程中,應該按要求編寫好十三種文檔,文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。
    ◇ 可行性分析報告:說明該軟件開發(fā)項目的實現(xiàn)在技術上、經濟上和社會因素上的可行性,評述為了合理地達到開發(fā)目標可供選擇的各種可能實施方案,說明并論證所選定實施方案的理由。
    ◇ 項目開發(fā)計劃:為軟件項目實施方案制訂出具體計劃,應該包括各部分工作的負責人員、開發(fā)的進度、開發(fā)經費的預算、所需的硬件及軟件資源等。
    ◇ 軟件需求說明書(軟件規(guī)格說明書):對所開發(fā)軟件的功能、性能、用戶界面及運行環(huán)境等作出詳細的說明。它是在用戶與開發(fā)人員雙方對軟件需求取得共同理解并達成協(xié)議的條件下編寫的,也是實施開發(fā)工作的基礎。該說明書應給出數(shù)據邏輯和數(shù)據采集的各項要求,為生成和維護系統(tǒng)數(shù)據文件做好準備。
    ◇ 概要設計說明書:該說明書是概要實際階段的工作成果,它應說明功能分配、模塊劃分、程序的總體結構、輸入輸出以及接口設計、運行設計、數(shù)據結構設計和出錯處理設計等,為詳細設計提供基礎。
    ◇ 詳細設計說明書:著重描述每一模塊是怎樣實現(xiàn)的,包括實現(xiàn)算法、邏輯流程等。
    ◇ 用戶操作手冊:本手冊詳細描述軟件的功能、性能和用戶界面,使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運行情況的有關知識,特別是操作方法的具體細節(jié)。
    ◇ 測試計劃:為做好集成測試和驗收測試,需為如何組織測試制訂實施計劃。計劃應包括測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差范圍等。
    ◇ 測試分析報告:測試工作完成以后,應提交測試計劃執(zhí)行情況的說明,對測試結果加以分析,并提出測試的結論意見。
    ◇ 開發(fā)進度月報:該月報系軟件人員按月向管理部門提交的項目進展情況報告,報告應包括進度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。
    ◇ 項目開發(fā)總結報告:軟件項目開發(fā)完成以后,應與項目實施計劃對照,總結實際執(zhí)行的情況,如進度、成果、資源利用、成本和投入的人力,此外,還需對開發(fā)工作做出評價,總結出經驗和教訓。
    ◇ 軟件維護手冊:主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護過程的說明,便于軟件的維護。
    ◇ 軟件問題報告:指出軟件問題的登記情況,如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等,為軟件修改提供準備文檔。
    ◇ 軟件修改報告:軟件產品投入運行以后,發(fā)現(xiàn)了需對其進行修正、更改等問題,應將存在的問題、修改的考慮以及修改的影響作出詳細的描述,提交審批。
    可行性分析報告
    1 引言
    1.1 編寫目的:闡明編寫可行性研究報告的目的,提出讀者對象。
    1.2 項目背景:應包括
    ● 所建議開發(fā)軟件的名稱
    ● 項目的任務提出者、開發(fā)者、用戶及實現(xiàn)軟件的單位
    ● 項目與其他軟件或其他系統(tǒng)的關系。
    1.3 定義:列出文檔中用到的專門術語的定義和縮寫詞的原文。
    1.4 參考資料:列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源,可包括
    ● 項目經核準的計劃任務書、合同或上級機關的批文
    ● 與項目有關的已發(fā)表的資料
    ● 文檔中所引用的資料,所采用的軟件標準或規(guī)范
    2 可行性研究的前提
    2.1 要求:列出并說明建議開發(fā)軟件的的基本要求,如
    ● 功能
    ● 性能
    ● 輸入/輸出
    ● 基本的數(shù)據流程和處理流程
    ● 安全與保密要求
    ● 與軟件相關的其他系統(tǒng)
    ● 完成日期
    2.2 目標:可包括
    ● 人力與設備費用的節(jié)省
    ● 處理速度的提高
    ● 控制精度或生產力的提高
    ● 管理信息服務的改進
    ● 決策系統(tǒng)的改進
    ● 人員工作效率的提高
    2.3 條件、假定和限制:可包括
    ● 建議開發(fā)軟件運行的最短壽命
    ● 進行顯然方案選擇比較的期限
    ● 經費來源和使用限制
    ● 法律和政策方面的限制
    ● 硬件、軟件、運行環(huán)境和開發(fā)環(huán)境的條件和限制
    ● 可利用的信息和資源
    ● 建議開發(fā)軟件投入使用的最遲時間
    2.4 可行性研究方法
    2.5 決定可行性的主要因素
    3 對現(xiàn)有系統(tǒng)的分析
    3.1 處理流程和數(shù)據流程
    3.2 工作負荷
    3.3 費用支出:如人力、設備、空間、支持性服務、材料等項開支
    3.4 人員:列出所需人員的專業(yè)技術類別和數(shù)量
    3.5 設備
    3.6 局限性:說明現(xiàn)有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)
    4 所建議技術可行性分析
    4.1 對系統(tǒng)的簡要描述
    4.2 與現(xiàn)有系統(tǒng)比較的優(yōu)越性
    4.3 處理流程和數(shù)據流程
    4.4 采用建議系統(tǒng)可能帶來的影響
    ● 對設備的影響
    ● 對現(xiàn)有軟件的影響
    ● 對用戶的影響
    ● 對系統(tǒng)運行的影響
    ● 對開發(fā)環(huán)境的影響
    ● 對經費支出的影響
    4.5 技術可行性評價:包括
    ● 在限制條件下,功能目的是否達到
    ● 利用現(xiàn)有技術,功能目的是否達到
    ● 對開發(fā)人員數(shù)量和質量的要求,并說明能否滿足
    ● 在規(guī)定的期限內,開發(fā)能否完成
    5 所建議系統(tǒng)經濟可行性分析
    5.1 支出
    5.2 效益
    5.3 收益/投資比
    5.4 投資回收周期
    5.5 敏感性分析:指一些關鍵性因素,如:
    ● 系統(tǒng)生存周期長短
    ● 系統(tǒng)工作負荷量
    ● 處理速度要求
    ● 設備和軟件配置變化對支出和效益的影響等的分析