軟體文檔[軟體工程知識]

軟體文檔(Document)也稱檔案，通常是指的是一些記錄的數據和數據媒體，它具有固定不變的形式，可被任何計算機閱讀。在軟體工程中，文檔常常用來表示對活動、需求、過程或結果進行描述、定義、規定或認證的任何書面或圖示的信息，他們描述和規定了軟體設計和實現細節，說明使用軟體的操作命令。

文檔是軟體產品的一部分，沒有文檔的軟體就不稱其為軟體。軟體文檔的編制在軟體開發工作中占有突出的地位和相當大的工作量。高質量和高效的開發、分發、管理和維護文檔對於轉讓、變更、修正、擴充和使用文檔，對於充分發揮軟體產品的效益有著重要的意義。

然而，在實際工作中，軟體開發人員普遍對編制文檔不感興趣。

作用和分類

作用

在軟體的生產過程中，總是伴隨著大量的信息要記錄、使用。因此，軟體文檔在產品的開發過程中起著重要的作用。

1. 提高軟體開發過程的能見度；

2. 記錄開發過程的相關信息；

3. 提高開發效率；

4. 作為開發人員在一定階段的工作成果和結束標誌；

5. 便於潛在用戶了解軟體的功能、性能等各項指標。

分類

更具形式，軟體文檔可大致分為兩類：

1. 工作表格：包括開發過程中填寫的各種圖示；

2. 文檔或檔案：包括應編輯的技術資料或技術管理資料。

根據文檔產生和使用範圍，軟體文檔大致可分為三類：

1. 開發文檔；

2. 管理文檔；

3. 用戶文檔。

根據文檔類容，軟體文檔又可分為兩類：

1. 用戶文檔；

2. 系統文檔。

管理和維護

在整個軟體生存期中，各種文檔作為半成品或是最終成品，會不斷生成、修改或補充。為了最終得到高質量的產品必須加強對文檔的管理，一下幾個方面是應該做到的：

1. 軟體開發小組應當設立一位文檔管理員，管理所有文檔；

2. 軟體開發小組成員可根據工作需要在自己手中保存一些個人文檔；

3. 開發人員只保存著主文檔中與它工作有關的部分文檔；

4. 在新文檔取代舊文檔時，管理人員應隨時修訂主文本，使其及時反應更新了的類容；

5. 項目開發結束時，文檔管理人員應收回開發人員的個人文檔，與主文檔對比差異，著手解決有差異的地方；

6. 在開發過程中，嚴格控制修改已經完成的文檔。