概述
在產(chǎn)品研發(fā)和制造領(lǐng)域,技術(shù)文檔分為兩類:
- 一類指產(chǎn)品開發(fā)中要用到的 研發(fā)文檔仗嗦;
- 一類是面向產(chǎn)品用戶的 用戶文檔膘滨。
產(chǎn)品全生命周期
產(chǎn)品全生命周期,大致梳理如下:
- 在產(chǎn)品研制階段稀拐,研發(fā)文檔 伴隨研發(fā)活動輸出火邓、記錄和傳遞產(chǎn)品開發(fā)信息
- 在產(chǎn)品運維階段,用戶文檔 為用戶使用和維護產(chǎn)品提供指導德撬。
研發(fā)文檔
研發(fā)文檔 指產(chǎn)品研發(fā)過程中使用的文檔铲咨,用于詳細記錄產(chǎn)品的研發(fā)目的、研發(fā)時限蜓洪、實現(xiàn)方法纤勒、設(shè)計要求等。
- 目標用戶:讀者一般是與該研發(fā)項目有直接關(guān)系的隆檀、具有一定技術(shù)能力的工程師摇天。
- 作用:作為項目執(zhí)行的參考粹湃,為項目的如期完成、質(zhì)量跟蹤以及后續(xù)發(fā)展等問題提供文字上的依據(jù)泉坐。
用戶文檔
用戶文檔 詳細解釋產(chǎn)品的具體使用操作方法为鳄、功能原理、故障處理坚冀、安全提示济赎、服務信息等。
- 目標用戶:讀者一般是產(chǎn)品用戶记某、技術(shù)支持工程師和售后服務人員。
- 作用:作為產(chǎn)品和用戶溝通的橋梁构捡,為產(chǎn)品的長期維護和發(fā)展提供良好的保障液南。
寫在后面
技術(shù)文檔為企業(yè)的商務目標服務,為產(chǎn)品和服務而生勾徽。高介入度的產(chǎn)品(toB)越來越需要技術(shù)文檔的支撐滑凉,主要原因如下:
- 決策時間長,需要的支撐信息多
- 產(chǎn)品昂貴
- 操作風險高
- 不被人熟悉的新功能多