概述
在產品研發(fā)和制造領域,技術文檔分為兩類:
- 一類指產品開發(fā)中要用到的 研發(fā)文檔;
- 一類是面向產品用戶的 用戶文檔。

產品全生命周期
產品全生命周期,大致梳理如下:

- 在產品研制階段,研發(fā)文檔 伴隨研發(fā)活動輸出、記錄和傳遞產品開發(fā)信息
- 在產品運維階段,用戶文檔 為用戶使用和維護產品提供指導。
研發(fā)文檔
研發(fā)文檔 指產品研發(fā)過程中使用的文檔,用于詳細記錄產品的研發(fā)目的、研發(fā)時限、實現方法、設計要求等。
- 目標用戶:讀者一般是與該研發(fā)項目有直接關系的、具有一定技術能力的工程師。
- 作用:作為項目執(zhí)行的參考,為項目的如期完成、質量跟蹤以及后續(xù)發(fā)展等問題提供文字上的依據。
用戶文檔
用戶文檔 詳細解釋產品的具體使用操作方法、功能原理、故障處理、安全提示、服務信息等。
- 目標用戶:讀者一般是產品用戶、技術支持工程師和售后服務人員。
- 作用:作為產品和用戶溝通的橋梁,為產品的長期維護和發(fā)展提供良好的保障。
寫在后面
技術文檔為企業(yè)的商務目標服務,為產品和服務而生。高介入度的產品(toB)越來越需要技術文檔的支撐,主要原因如下:
- 決策時間長,需要的支撐信息多
- 產品昂貴
- 操作風險高
- 不被人熟悉的新功能多