1. 技术文档怎样才算好？

技术文档怎么才算好？从自己的阅读体验结合技术文档的阅读对象进行分析，答案就很明显。

一份文档，如果阅读对象可以从中理解其中的中心思想，并能提升自己的认知或思想，或者从中学到一定的技术，解决一个或多个实际问题，就算是合格的技术文档了。

而如果同时，在阅读过程中，还能收获到愉悦的感觉，则可以称得上是一份好的技术文档了。

2. 怎样写好技术文档？

既然提到技术文档，那么阅读对象当然是技术工作者或者与技术工作相关的人员了。例如需求文档的阅读对象是需求调研者、客户、程序员等；操作说明书的阅读对象是使用系统的用户和客户；产品白皮书的阅读对象是对产品感兴趣的潜在客户。

首先，区分阅读对象。在编写技术文档之前，要先定位清楚文档的阅读对象是谁。在编写的过程中，要换位思考，时刻考虑阅读对象在阅读过程中，是否存在不理解的内容，或者在阅读之前，要具备哪些预备知识。如果阅读对象是小学生，文档中描述的是微积分的内容，即使文档写得再精彩，这份文档基本上也属于是无效的。

其次，注意文档排版。合格的技术文档，在排版上是不允许出现任何问题的。常见的排版问题包括：使用非系统自带的字体的；字体大小设置不合理的；行距太小的；涉及的逻辑全是文字描述而无流程图或数据流向图配合的；图片风格各异排版凌乱的；表格跨页后不带表头的；页眉空白或页眉与文档不一致的；目录与内容不匹配的等等；

再次，行文风格统一。文档中，一般是需要在第一章节统一名词定义的。如统一介绍一下技术名词，全名太长的可以定义简称，然后在正文中全用简称，而不能一时简称一时全称。另外，句式不能过于复杂，应保持简单易懂的句式，以主动句为主，避免使用被动句和疑问句。应少用感叹词，同时避免模凌两可的词语出现（常见的如『可能』、『假设』、『也许』、『大部分』等等）。此外，标点符号要正确使用，每段的最后一句要以句号结尾，不能省略。

【未完待续，本文将持续整理并更新发布，期待交流】