【IT基礎】常見的開發文檔

Perface

　　随着技術的進步，小作坊式的軟體開發年代已經過去。目前的軟體開發能力在不斷提升，使用者對軟體的功能和性能要求也越來越高，軟體開發品質受到關注。

　　在軟體開發過程中，各種資料和代碼的管理需要經過統籌安排和管理，出現了各種軟體開發文檔，用于控制軟體開發過程。

軟體開發文檔是與開發階段對應的。

　　一般來說，每個階段至少産生一種文檔。軟體開發文檔描述了在軟體開發各階段中不同的任務。不同組織和公司有不同的開發文檔和規範，使用不同的開發模型産生的文檔内容也不相同。

軟體開發文檔指導不同階段的相關人員的工作，不同階段的設計人員會設計出相應階段的最終文檔。如需求設計文檔指導項目經理做軟體的架構設計，産生概要設計文檔；程式員使用概要設計文檔了解軟體某部分的功能，然後做具體的細化設計詳細設計文檔。按照軟體開發的階段，通常會生成以下幾種文檔：

可行×××執行

   軟體項目的可行×××執行需要列舉出需要的技術、人員、資金、時間周期以及法律等方面的因素，最終目的是認證一個軟體項目是否可以開發。

　　可行×××報告通常由軟體團隊的高層，或者是軟體項目的發起人、投資人等參加。

　　可行×××報告中還應當對于現有的資源給出幾種不同的解決方案供讨論使用。

　　軟體可行×××報告的結果直接決定了一個軟體項目是否啟動。

項目開發計劃

   項目開發計劃的目的是使用檔案形式，把開發過程中各工作的負責人、開發進度以及需要的續費預算、所需的軟體和硬體等都描述出來。

　　後續的工作根據項目開發文檔安排調配資源。項目開發文檔是整個開發項目的資源描述文檔，在編寫的時候要從開發組織的實際情況出發，合理安排資源。

軟體需求說明書

   軟體需求說明書是軟體開發組織與使用者之間的接口文檔，是整個軟體開發的基礎，軟體需求說明書是軟體供求雙方對軟體功能的一個具體描述文檔，通常由軟體開發組織編寫。

　　該文檔包括了軟體的開發任務、功能約定、開發周期等，使用者根據軟體開發組織的需求設計提出自己的意見，修改後行形成最終文檔。

　　需求說明書對軟體開發組織來說很重要，軟體開發的設計和測試工作都是針對需求文檔進行的。

概要設計

   概要設計文檔說明了整個程式設計的架構和工作流程，是詳細設計文檔的基礎。

　　概要設計描述整個系統的處理流程、子產品劃分、接口設計以及出錯處理等内容。

　　概要設計的好壞決定了軟體的優劣，通常是項目經理設計該文檔，并且經過讨論後形成最終文檔。

詳細設計

   詳細設計是一個軟體子產品或者流程的具體描述文檔。

   詳細設計文檔包括具體程式的功能描述、性能要求、輸入輸出格式、算法、存儲配置設定等内容。

   對于簡單的軟體可以不做詳細設計，在代碼中做相應詳細的注釋即可。對于大型的軟體，至少要在關鍵流程做詳細設計，并且盡量保證詳細設計的文檔與代碼的對應關系便于維護管理。

詳細設計文檔一般由程式員編寫。

使用者手冊

   前面介紹的幾種文檔都是軟體開發組織使用的，文檔結構規範、内容使用術語較多，便于開發組織内部交流。

   使用者手冊編寫的目的是要使用非術語描述軟體系統具有的功能和使用方法。使用者在閱讀使用手冊後可以了解軟體的功能和用途，并且通過說明書可以操作軟體。

   使用者說明書通常包括軟體的功能、運作環境、操作方法以及示例、常見出錯問題及解答。使用者手冊要保證内容簡潔，易于使用者了解。

其他文檔

   在軟體開發過程中還會産生一些其他文檔，常見的有測試計劃、測試報告、開發進度表和項目總結報告等。

   其中，測試是比較重要的部分，一個軟體的優劣測試起到很大作用。測試是與開發并進的，包括單元測試、內建測試、功能測試和完整性測試等。測試的目的是發現軟體中的缺陷，幫助改進軟體的健壯性。