和大多數人一樣，我們明白軟件文檔的重要性，但不幸的是我們往往忽視它的產生和維護以及使用。
普遍在軟件文檔存在的問題：
錯誤的語法或拼錯的詞語
不完整
過時或不準確
過於冗長
未經解釋的縮略語或專用術語
查找信息困難
存在問題的主要原因：
工程進度壓力，優先考慮編碼開發
編寫文檔需要花費成本，項目經理減少投入，只是裝點門面
由開發人員編寫文檔
專用的技術文檔編寫者或業務分析師編寫文檔對技術部門把握不準確
解決方法：
寫文檔需要團隊協作，開發人員和文檔編寫者利用彼此的長處，取長補短；如開發人員提供技術細節，然後文檔編寫者按照正確的語法組織和編輯內容。
文檔質量評價標準：
軟件文檔的目的：
傳達一個系統的技術要素和使用方法
提供軟件開發工程中需求、決策、行爲、角色、職責的書面記錄
