如何写出一个高质量的技术文档？

从某种角度上，技术文档应该贯穿于整个软件开发过程，无论是需求、设计，还是开发、测试，又或者投产、运维，都少不了技术文档这个角色，但实际上，技术文档的质量，即使在同一个团队内部，都可能参差不齐。

熟悉Oracle的朋友，可能都知道，Oracle官方文档，可以称作"体系"，无论从单个文档的质量，还是整体文档的层次，都堪称典范，官方文档可以让你了解到公开可以了解的大部分信息，这对于产品推广其实是有益的。

写得好的技术文档可以让读者很容易了解想表达的内容，指导他们的工作，但如果写的晦涩，很可能出现不知所云的情况，对产品的使用来讲起到了一定的反向作用。

碰巧看到中国标准化协会发布了一个团体标准《技术文档的用户体验评估规范》，起草单位有厂商、各大科研院校，

https://www.ttbz.org.cn/StandardManage/Detail/114954/

按照介绍所说，本文件规定了对技术文档执行用户体验评估的基本要求以及评估流程，并给出了确定评估目标和主体、设定评估计划、实施评估实验、完成评估结果的要求。

本文件适用于产品与服务的技术文档的用户体验评估。

评估维度主要有以下三个方面，

（1）内容质量：确保文档准确、一致、易理解，且符合 GB/T 19678.1—2018中对语言文字的要求。

（2）可用性：评估文档在有效性、效率和满意度方面的表现。

（3）主观体验：评估用户在文档使用中的感知、认知和情绪体验。

但是它的标准文档是不公开的。

写文档的水平，是需要锻炼的，多看好的文档，理解它的构造，再结合上一些相应的标准要求，循序渐进，才可以逐步提升文档的编辑能力，进一步提高技术文档的质量。

如果您认为这篇文章有些帮助，还请不吝点下文章末尾的"点赞"和"在看"，或者直接转发朋友圈，