技术文档是介绍产品技术原理和使用方法的知识产品,一般面向两类用户:一类是产品研发技术人员,一类是购买产品的用户。我们这里重点介绍后一类文档的写作。
技术文档写作不是简单的文字工作,是一种带有布道和传播性质工作。技术文档写作者如同一名优秀的销售人员,把产品介绍给用户,不过是以技术文字的形式。因此,技术文档写作更是一种服务工作,需要直接面向客户,以用户为中心。
从技术文档写作者角度,技术文档工作内容通常包括但不限于如下:
- 熟悉产品是前提
产品的技术原理、功能特点、性能指标等都需要理解消化。关于怎么样熟悉产品,就是向研发、测试人员去了解学习,亲自使用产品,获取尽可能全面的产品的来世今生、点线面体,方方面面的知识。
- 了解用户再写作
用户都是哪些岗位的人,用户的知识水平怎么样,用户希望产品能达成什么任务目标,用户什么时候会使用产品等等。站在用户使用产品的角度不断向自己抛出问题,写作过程中时刻站在用户的角度。将大脑中掌握的产品知识,输出成用户无障碍阅读的文字。为了达成目标写作过程中需要运用一些写作技巧,要遵循一定的规范格式。
- 审核修改不嫌烦
邀请用户、产品专家、文档专家进行同行评审(peer review),根据评审意见反复修改文档。好的文档,能够经得起时间洗涤的文档,往往是千锤百改出来的。
- 交付用户刚开始
将文档交付给用户。之后需要和用户保持联系,及时获取用户对文档的反馈意见,根据用户意见及时修改文档,直到用户满意。交付是一个开始,不是结束,文档有自己的生命周期,在生命周期中它都是活的,要发挥作用。