在某高科技企业，有个做测试的小伙子换岗到了文档部。起初态度很是倨傲，言必称“我们研发如何如何”，“产品如何如何”。倨傲缘于“我比你们懂产品，懂技术。”

过段时间，他去一线客户现场出了趟差，回来之后变谦虚了，讨论问题会说“客户如何如何”，“现场如何如何”。谦虚缘于“只懂产品并不能做出符合客户需求的文档”。

为什么只懂技术写不好文档呢？

好的技术文档，要“易于使用，易于理解，易于查找”。

先说易于理解。我写得清清楚楚，读者却不能理解，有两个常见的原因：用了技术语言，用户看不懂；认为用户已经知道了某些背景知识，实际上用户并不知道。

举个真实的例子。这是三个不同厂家的手册，您觉得哪一个比较容易理解。

A厂家

B厂家

C厂家

您来打个分，看看读者的真实感受是什么：

这个例子说明，“易理解”不在于多专业、多详尽——写得细未必看得懂。

“易于使用”是指技术文档的功能性。使用技术文档， 能有效降低服务成本，提升产品的运行可靠性，降低故障频度等等 。

如何使技术文档易于使用呢？

• 从用户任务出发，分析用户的信息需求。

• 用做产品的方法做文档设计，进行架构管理，实现同源开发。

• 在实际场景中测试和验证文档的效用，能否帮助用户自助使用和维护产品。

技术文档提升专业性，产生专门的价值，这在发达的工业国家已经应用了数十年。

早日实现专业化的技术信息设计与交付，能提升企业的产品和服务竞争优势，这既需要外部的市场需求驱动，也需要文档专业化自身的发展。