技術文檔，Technical Documentation，技術文檔分兩類，一類指開發中要用到的研發文檔，一類是給客戶看的客戶文檔。
術語名稱
英文稱為松香酸 Documentation
從業者稱為Technical writer
研發文檔
指研發過程中使用的文檔。英文一般稱為Specification。
文檔中詳細記錄產品的研發目的，開發階段，研發時限等。閱讀對象一般為了解項目，有一定基礎的工程師。文檔作為項目執行的參考，為項目的如期完成，項目質量跟蹤，以及項目的后續發展等問題提供了可依據的文字上的依據。
客戶文檔
指產品發布以后，公布給用戶使用的文檔。英文一般稱為Customer Documentation。
文檔詳細解釋產品的具體使用方法，安全提示，客戶服務信息等。閱讀對象一般為用戶，技術支持工程師，售后服務人員。文檔作為產品和市場接軌的橋梁，為產品的在市場上贏得客戶的青睞，以及產品的長期發展做出了良好的保障。
技術文檔的要求
技術文檔要符合以下要求：
1.針對性
文檔編制以前應分清讀者對象，按不同的類型、不同層次的讀者，決定怎樣適應他們的需要。
① 對于面向管理人員和用戶的文檔，不應像開發文檔(面向軟件開發人員)那樣過多地使用軟件的專業術語。難以避免使用的詞匯，應在文檔中添加詞匯表，進行解釋。
② 開發文檔使用的專業詞匯未被廣泛認知的，應添加注釋進行說明。
③ 縮寫詞未被廣泛認知的，應在其后跟上完整的拼寫。
2.正確性
① 沒有錯字，漏字。
② 文檔間引用關系正確。
③ 文檔細節(Title/History)正確。
3.準確性
① 意思表達準確清晰，沒有二義性。
② 正確使用標點符號，避免產生歧義。
4.完整性
① 意思表達完整，能找到主語、謂語、賓語，沒有省略主語，特別是謂語。
② 一句話中不能出現幾個動詞一個賓語的現象。
③ 不遺漏要求和必需的信息。
5.簡潔性
① 盡量不要采用較長的句子來描述，無法避免時，應注意使用正確的標點符號。
② 簡潔明了，不累贅冗余，每個意思只在文檔中表達一次。
③ 每個陳述語句，只表達一個意思。
④ 力求簡明，如有可能，配以適當的圖表，以增強其清晰性。
6.統一性
① 統一采用專業術語和項目規定的術語集。
② 同一個意思和名稱，前后描述的用語要一致。
③ 文檔前后使用的字體要統一。
④ 同一課題若干文檔內容應該協調一致，沒有矛盾。
7.易讀性
① 文字描述要通俗易懂。
② 前后文關聯詞使用恰當。
③ 文檔變更內容用其他顏色與上個版本區別開來。
④ 測試步驟要采用列表的方式，用1)、2)、3)…等數字序號標注。
參考資料 >