軟件工程文檔編寫指南

《軟件工程文檔編寫指南》由會員上傳分享，免費在線閱讀，更多相關內容在行業(yè)資料-天天文庫。

1、軟件文檔編寫指南封面格式：文檔編號版本號文檔名稱：項目名稱：項目負責人：編寫年月日校對年月日審核年月日批準年月日開發(fā)單位系統(tǒng)規(guī)約說明書（SystemSpecification）一．引言A.文檔的范圍和目的B.概述1．目標2．約束二．功能和數據描述A.系統(tǒng)結構1．結構關系圖2．結構關系圖描述三．子系統(tǒng)描述A.子系統(tǒng)N的結構圖規(guī)約說明B.結構字典C.結構連接圖和說明四．系統(tǒng)建模和模擬結構A.用于模擬的系統(tǒng)模型A.模擬結果B.特殊性能一．軟件項目問題A.軟件項目可行性研究報告B.軟件項目計劃二．附錄軟件項目

2、可行性研究報告（ReportforFeasibilityStudy）一．引言1．編寫目的（闡明編寫可行性研究報告的目的，指出讀者對象）2．項目背景（應包括：（1）所建議開發(fā)的軟件名稱；（2）項目的任務提出者、開發(fā)者、用戶及實現單位；（3）項目與其他軟件或其他系統(tǒng)的關系。）3．定義（列出文檔中用到的專門術語的定義和縮略詞的原文。）4．參考資料（列出有關資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。）二．可行性研究的前提1．要求（列出并說明建議開發(fā)軟件的基本要求，如（1）功能；（2）性能；（3）輸

3、出；（4）輸入；（5）基本的數據流程和處理流程；（6）安全與保密要求；（7）與軟件相關的其他系統(tǒng)；（8）完成期限。）2．目標（可包括：（1）人力與設備費用的節(jié)??；（2）處理速度的提高；（3）控制精度和生產能力的提高；（4）管理信息服務的改進；（5）決策系統(tǒng)的改進；（6）人員工作效率的提高，等等。）3．條件、假定和限制（可包括：（1）建議開發(fā)軟件運行的最短壽命；（2）進行系統(tǒng)方案選擇比較的期限；（3）經費來源和使用限制；（4）法律和政策方面的限制；（5）硬件、軟件、運行環(huán)境和開發(fā)環(huán)境的條件和限制；（6）

4、可利用的信息和資源；（7）建議開發(fā)軟件投入使用的最遲時間。）4．可行性研究方法5．決定可行性的主要因素三．對現有系統(tǒng)的分析1．處理流程和數據流程2．工作負荷3．費用支出（如人力、設備、空間、支持性服務、材料等項開支。）4．人員（列出所需人員的專業(yè)技術類別和數量。）5．設備6．局限性（說明現有系統(tǒng)存在的問題以及為什么需要開發(fā)新的系統(tǒng)。）四．所建議技術可行性分析1．對系統(tǒng)的簡要描述2．處理流程和數據流程3．與現有系統(tǒng)比較的優(yōu)越性4．采用建議系統(tǒng)可能帶來的影響（1）對設備的影響（2）對現有軟件的影響（1）對

5、用戶的影響（2）對系統(tǒng)運行的影響（3）對開發(fā)環(huán)境的影響（4）對運行環(huán)境的影響（5）對經費支出的影響1．技術可行性評價（包括：（1）在限制條件下，功能目標是否能夠達到；（2）利用現有技術，功能目標能否達到；（3）對開發(fā)人員數量和質量的要求，并說明能否滿足；（4）在規(guī)定的期限內，開發(fā)能否完成。）一．所建議系統(tǒng)經濟可行性分析1．指出（1）基建投資（2）其他一次性支出（3）經常性支出2．效益（1）一次性收益（2）經常性收益（3）不可定量收益3．收益/投資比4．投資回收周期5．敏感性分析（指一些關鍵性因素，如：

6、系統(tǒng)生存周期長短、系統(tǒng)工作負荷量、處理速度要求、設備和軟件配置變化對支出和效益的影響等的分析。）二．社會因素可行性分析1．法律因素（如，合同責任、侵犯專利權、侵犯版權等問題的分析。）2．用戶使用可行性（如，用戶單位的行政管理、工作制度、人員素質等能否滿足要求。）三．其他可供選擇的方案（逐個闡明其他可供選擇的方案，并重點說明未被推薦的理由。）四．結論意見（可能是：（1）可著手組織開發(fā)；（2）需待若干條件（如資金、人力設備等）具備后才能開發(fā)；（3）需對開發(fā)目標進行某些修改；（4）不能進行或不必進行（如技術

7、不成熟，經濟上不合算等）；（4）其他。）軟件項目計劃（SoftwareProjectPlan）一．引言1．編寫目的（闡明編寫軟件計劃的目的，指出讀者對象。）2．項目背景（可包括：（1）項目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關系。）3．定義（列出本文檔中用到的專門術語的定義和縮略詞的原文。）4．參考資料（可包括：（1）項目經核準的計劃任務書、合同或上級機關的批文；（2）文檔所引用的資料、規(guī)范等；列出資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。）二．項目概述1.工作內容（

8、簡要說明項目的各項主要工作,介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報告,則應在本節(jié)給出較詳細的介紹。)1.條件與限制（闡明為完成項目應具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時還應說明用戶及分合同承包者承擔的工作完成期限及其它條件與限制。）2.產品（1）程序（列出應交付的程序名稱使用的語言及存儲形式。）（2）文檔（列出應交付的文檔。）（3）運行環(huán)境（應包括硬件環(huán)境軟件環(huán)境。）4．服務（闡明開發(fā)單位可向用戶提供的服務.如人員培訓安裝保