軟件文檔管理指南GB/T16680-1996

《GB/T16680—1996軟件文檔管理指南》（由原國家技術監督局于1996年12月18日發布，1997年7月1日起實施，該標準為那些對軟件或基于軟件的產品的開發負有職赍的管理者提供軟件文檔的管理指南。該標準的目的在于協助管理者在他們的機構中產生有效的文檔。該標準涉及策略、標準、規程、資源和計劃，管理者必須關注這些內容，以便有效地管理軟件文檔。根據該標準，文檔是指一種數據媒體和其上所記錄的數據。它具有永久性并可以由人或機器閱讀。通常傾于描述人工可讀的內容，例如，技術文件、設計文件、版本說明文件。

軟件文檔的作用：管理依據、任務之間聯系的憑證、質量保證、培訓與參考；軟件維護支持、歷史檔案。

軟件文檔可歸入三種類別：開發文檔（描述開發過程本身)、產品文檔（描述開發過程的產物）、管理文檔（記錄項目管理的信息）。

1.文檔計劃

文檔計劃是指一個描述文檔編制工作方法的管理用文檔。該計劃主要描述要編制什么類型的文檔，這些文檔的內容是什么，何時編寫，由誰編寫，如何編寫，以及什么是影響期望結果的可用資源和外界因素。

文檔計劃一般包括以下幾方面的內容：

(1)列出應編制文檔的目錄。

(2)提示編制文檔應參考的標準。

(3)指定文檔管理員。

(4)提供編制文檔所需要的條件，落實文檔編寫人員、所需經費以及編制工具等。

(5)明確保證文檔質量的方法，為了確保文檔內容的正確性、合理性，應采取一定的措施，如評審、鑒定等等。

(6)繪制進度表，以圖表形式列出在軟件生存期各階段應產生的文檔、編制人員、編制日期、完成日期、評審日期等。

此外，文檔計劃規定每個文檔要達到的質量等級，以及為達到期望結果必須考慮哪些外部因素。文檔計劃還確定該計劃和文檔的分發，并且明確敘述參與文檔工作的所有人員的職賁。

2.開發文檔

開發文檔是描述軟件開發過程，包括軟件需求、軟件設計、軟件測試、保證軟件質量的一類文檔，開發文檔也包括軟件的詳細技術描述（程序邏輯、程序間相互關系、數據格式和存儲等)。開發文檔起到如下五種作用：

(1)它們是軟件開發過程中包含的所有階段之間的通信工具，它們記錄生成軟件需求、設計、編碼和測試的詳細規定和說明。

(2)它們描述幵發小組的職責。通過規定軟件、主題事項、文檔編制、質量保證人員以及包含在開發過程中任何其他事項的角色來定義做什么、如何做和何時做。

(3)它們用作檢驗點而允許管理者評定開發進度，如果開發文檔丟失、不完整或過時，管理者將失去跟琮和控制軟件項目的一個重要工具。

(4)它們形成了維護人員所要求的基本軟件文檔。而這些支持文檔可作為產品文檔的一部分。

(5)它們記錄軟件開發的歷史。基本的開發文擋有可行×××和項目任務書；需求規格說明：功能規格說明：設計規格說明，包括程序和數據規格說明；開發計劃；軟件集成和測試計劃；質量保證計劃、標準、進度：安全和測試信息。

3.產品文檔

產品文檔規定關于軟件產品的使用、維護、增強、轉換和傳輸的信息。產品文檔起到如下三種作用：

(1)為使用和運行軟件產品的任何人規定培訓和參考信息；

(2)使得那些未參加本軟件開發的程序員維護它；

(3)促進軟件產品的市場流通或提髙可接受性。

產品文檔用于下列類型的讀者：

(1)用戶。他們利用軟件輸入數據、檢索信息和解決問題；

(2)運行者。他們在計算機系統上運行軟件；

(3)維護人員。他們維護、增強或變更軟件。

產品文檔包括如下內容：

(1)用于管理者的指南和資料，他們監督軟件的使用；

(2)宣傳資料。通告軟件產品的可用性并詳細說明它的功能、運行環境等：

(3)一般信息。對任何有興趣的人描述軟件產品。

基本的產品文檔有培訓手冊；參考手冊和用戶指南；軟件支持手冊；產品手冊和廣告信息。

4.管理文檔

管理文檔建立在項目信息的基礎上，諸如：

(1)開發過程的每個階段的進度和進度變更的記錄；

(2)軟件變更情況的記錄；

(3)相對于開發的判定記錄；

(4)職責定義。

這種文檔從管理的角度規定涉及軟件生存的信息。相關文檔的詳細規定和編寫格式見GB8567。

5.文檔等級

文檔等級是指所需文檔的一個說明，它指出文檔的范圍、內容、格式及質量，可以根據項目、費用、預期用途、作用范圍或其他因素選擇文檔等級。每個文檔的質量必須在文檔計劃期間就有明確的規定，文檔的質量可以按文檔的形式和列出的要求劃分為4級。

(1)最低限度文檔(1級文檔)：適合開發工作量低于一個人月的開發者自用程序。該文檔應包含程序清單、開發記錄、測試數據和程序簡介。

(2)內部文檔（2級文檔）：可用于在精心研究后被認為似乎沒有與其他用戶共享資源的專用程序。除1級文檔提供的信息外，2級文檔還包括程序淸單內足夠的注釋以幫助用戶安裝和使用程序。

(3)工作文檔（3級文檔）：適合于由同一單位內若干人聯合開發的程序，或可被其他單位使用的程序。

(4)正式文檔（4級文檔）：適合那些要正式發行供普迪使用的軟件產品。關鍵性程序或具有重復管理應用性質(如工資計算)的程序需要4級文檔。4級文檔應進守DES567的有關規定.

轉載于:https://blog.51cto.com/pmpok/1318869

總結

以上是生活随笔為你收集整理的系统集成资质培训 - 标准系列 -软件文档管理指南的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。