软件产品因为其特点,常常需要为用户提供帮助文档,有好的帮助文档的产品常常会受到用户的青睐。
但是有很多企业不能为用户提供一份细致的帮助文档,因为他们没有用好的方法或工具,需要耗费大量精力去完成文字工程的搭建,也不会使用语法和逻辑。
还有一种情况是,很多传统软件的客户,没有使用文档的习惯,很多时候,帮助文档仅仅是作为合同约定的交付物存在,许多客户不会去使用这些文档,更多依赖现场的培训和技术支持。
但现如今大部分软件产品都通过互联网向用户提供服务了,在线文档才是最高效的客户服务通道,我们熟知的那些开源软件都配有高质量的在线文档。好文档是优秀产品的标配,它不仅可以帮产品带来更多的用户,而且还可以提升用户的使用体验。
那么如何才能制作好的帮助文档呢?
明确帮助文档的受众对象
写产品帮助文档,如果是为了交差而写,脑袋很容易卡壳,思路无法拓展。在敲键盘之前,我们首先要想清楚这份文档是写给谁看的,通过这份文档可以帮读者解决什么问题。写作是我们输出影响力的一种能力,其最终目的是为了改变读者的信息、行为,否则就是言之无物的垃圾。等明确了目标读者和意义之后,我们的思路也就打开了。
简单的表述
编写技术文档的过程中会遇到哪些常见问题呢?通常我们习惯一上来就非常详尽地介绍这款产品有哪些特性,具体怎么安装、配置和使用等等,其实大部分潜在用户都是初次接触此类产品,他对我们的产品还没有完整的认知,压根不知道这款产品到底能帮他解决什么问题,对他而言有什么价值,一上来就深入细节就很容易把潜在用户搞蒙。编写帮助文档不是简单的增加文档篇幅,尽量简洁易懂的文字ÿ