概述
在产品研发和制造领域,技术文档分为两类:
- 一类指产品开发中要用到的 研发文档;
- 一类是面向产品用户的 用户文档。
产品全生命周期
产品全生命周期,大致梳理如下:
- 在产品研制阶段,研发文档 伴随研发活动输出、记录和传递产品开发信息
- 在产品运维阶段,用户文档 为用户使用和维护产品提供指导。
研发文档
研发文档 指产品研发过程中使用的文档,用于详细记录产品的研发目的、研发时限、实现方法、设计要求等。
- 目标用户:读者一般是与该研发项目有直接关系的、具有一定技术能力的工程师。
- 作用:作为项目执行的参考,为项目的如期完成、质量跟踪以及后续发展等问题提供文字上的依据。
用户文档
用户文档 详细解释产品的具体使用操作方法、功能原理、故障处理、安全提示、服务信息等。
- 目标用户:读者一般是产品用户、技术支持工程师和售后服务人员。
- 作用:作为产品和用户沟通的桥梁,为产品的长期维护和发展提供良好的保障。
写在后面
技术文档为企业的商务目标服务,为产品和服务而生。高介入度的产品(toB)越来越需要技术文档的支撑,主要原因如下:
- 决策时间长,需要的支撑信息多
- 产品昂贵
- 操作风险高
- 不被人熟悉的新功能多