軟體開發文件編寫規範

阿新 • • 發佈：2018-11-11

對於軟體工程學科的同學都知道，軟體工程是一門技術含量高設計極其複雜的學科。為了控制好軟體產品質量和規範，就必須用大量的文件約束軟體工程的進度和狀態。浩大的軟體工程對於缺少工作和專案經驗的人來說，必然是摸不著頭腦不知從何開始。為了讓大家能夠快速適應標準的軟體開發過程，今天我為大家粗略的描述開發中需要的文件，本人將按照國家軟體質量標準來說明介紹。
　　在專案開發過程中，應該按要求編寫好十三種文件，文件編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性。

專案文件管理軟體我推薦大家使用（Telelogic doors V8.0），此軟體可以很好的管理好繁多的專案文件。

Telelogic doors V8.0下載：http://pan.baidu.com/share/home?uk=4076915866&view=share#category/type=0

Telelogic doors V8.0 使用方法介紹： http://zz563143188.iteye.com/blog/1830393

接下來將是十三種文件的介紹（文件模板請下載附件）

　　1.◇ 可行性分析報告：

　　　　說明該軟體開發專案的實現在技術上、經濟上和社會因素上的可行性，評述
為了合理地達到開發目標可供選擇的各種可能實施方案，說明並論證所選定實施方案
的理由。

　　2.◇ 專案開發計劃：
　　　為軟體專案實施方案制訂出具體計劃，應該包括各部分工作的負責人員、開
發的進度、開發經費的預算、所需的硬體及軟體資源等。

　　3.◇ 軟體需求說明書（軟體規格說明書，系統測試需要的標準文件）：
　　對所開發軟體的功能、效能、使用者介面及執行環境等作出詳細的說明。它是
在使用者與開發人員雙方對軟體需求取得共同理解並達成協議的條件下編寫的，也是實
施開發工作的基礎。該說明書應給出資料邏輯和資料採集的各項要求，為生成和維護
系統資料檔案做好準備。

　　4.◇ 概要設計說明書：

　　　　該說明書是概要實際階段的工作成果，它應說明功能分配、模組劃分、程式
的總體結構、輸入輸出以及介面設計、執行設計、資料結構設計和出錯處理設計等，
為詳細設計提供基礎。

　　5.◇ 詳細設計說明書：
　　　　著重描述每一模組是怎樣實現的，包括實現演算法、邏輯流程等。

　　6.◇ 使用者操作手冊：
　　　　本手冊詳細描述軟體的功能、效能和使用者介面，使使用者對如何使用該軟體
得到具體的瞭解,為操作人員提供該軟體各種執行情況的有關知識，特別是操作方法
的具體細節。

　　7.◇ 測試計劃：
　　　　為做好整合測試和驗收測試，需為如何組織測試製訂實施計劃。計劃應包括
測試的內容、進度、條件、人員、測試用例的選取原則、測試結果允許的偏差範圍等。

　　8.◇ 測試分析報告：
　　　　測試工作完成以後，應提交測試計劃執行情況的說明，對測試結果加以分
析，並提出測試的結論意見。

　　9.◇ 開發進度月報：
　　　　該月報系軟體人員按月向管理部門提交的專案進展情況報告，報告應包括
進度計劃與實際執行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月
的打算等。

　　10.◇ 專案開發總結報告：
　　　　軟體專案開發完成以後，應與專案實施計劃對照，總結實際執行的情況，
如進度、成果、資源利用、成本和投入的人力，此外，還需對開發工作做出評價，
總結出經驗和教訓。

　　11.◇ 軟體維護手冊：
　　　　主要包括軟體系統說明、程式模組說明、操作環境、支援軟體的說明、維護
過程的說明，便於軟體的維護。

　　12.◇ 軟體問題報告：
　　　　指出軟體問題的登記情況，如日期、發現人、狀態、問題所屬模組等，為
軟體修改提供準備文件。

　　13.◇ 軟體修改報告：
　　　　軟體產品投入執行以後，發現了需對其進行修正、更改等問題，應將存在
的問題、修改的考慮以及修改的影響作出詳細的描述，提交審批。