文檔是影響軟件可維護性的決定因素。由于長期使用的大型軟件系統在使用過程中必然會經受多次修改,所以文檔比程序代碼更重要。
軟件文檔應該滿足下述要求:
軟件文檔應該滿足下述要求:
(1) 必須描述如何使用這個系統,沒有這種描述時即使是最簡單的系統也無法使用。
(2) 必須描述怎樣安裝和管理這個系統。
(3) 必須描述系統需求和設計。(4) 必須描述系統的實現和測試,以便使系統成為可維護的。
文檔可以分為用戶文檔和系統文檔兩類。
1.用戶文檔
用戶文檔是用戶了解系統的第一步,它應該能使用戶獲得對系統的準確的初步印象。
?(1) 功能描述
?(2) 安裝文檔
?(3) 使用手冊
?(4) 參考手冊(要完整)
?(5) 操作員指南(如果需要有系統操作員的話)
2.系統文檔
? ? ? ?所謂系統文檔指從問題定義、需求說明到驗收測試計劃這樣一系列和系統實現有關的文檔。描述系統設計、實現和測試的文檔對于理解程序和維護程序來說是極端重要的。
? ? ? ?和用戶文檔類似,系統文檔的結構也應該能把讀者從對系統概貌的了解,引導到對系統每個方面每個特點的更形式化更具體的認識