导语
文档能力，是一个优秀工程师必备的基础能力，也是目前招聘被严重低估的一个能力。简单来说，好的文档“内在有逻辑，外表有颜值”，正所谓内外兼修才行。
01
什么是文档
然而，何为技术文档？很难定义，以项目实施和技术研究举例如下：
从项目实施角度，以时间先后顺序有以下几个阶段：
售前阶段： 售前方案、售前PPT、市场调研报告等
合同阶段：招标书、投标书、合同等
实施阶段：技术方案、实施方案、详细设计、概要设计、测试方案、测试报告等
交付阶段：验收报告、运维手册等
从技术研究角度，以研究的内容分为以下几个部分：
背景介绍：研究意义、研究背景、政策依据、国内外法规依据等
需求分析：问题分析、现有方案调研与分析、残留问题分析等
技术路线：关键技术调研报告、关键技术路线、竞品方案分析等
创新点：同类产品或技术调研、同类专利调研、同类论文调研等
不管什么方面，文档的核心目的在于：人们通过白纸黑字的方式建立一种沟通机制，通过语言文字准确表达作者观点，提高人与人之间的沟通效率。
02 内在有逻辑的好文档
逻辑学是一个大的概念，有兴趣的可以读一读 《有用的逻辑学》。简单的来说，内在有逻辑需要从以下三个方面入手。
1、目标明确
这个文档的目标是什么？
是为了宣传？还是为了交付客户？交付客户的目的是为了让他明白我们的方案？还是让他不明觉厉就好？
这个文档的阅读对象是谁？
公司内部员工？业界同行？普通用户？大企业客户？还是领导？
这个文档什么时候交付？
文档质量一定是跟时间相关的，在给定时间约束情况下，先解决0和1的是否完成问题，再解决质量问题。
基于阅读对象的知识背景，围绕目标，在时间或其他约束条件下，定义文档的整个逻辑框架是个非常重要的事情，也是一个非常烧脑的事情，考验的是一个人的知识沉淀。
2、结构清晰
结构是什么？
简单来说就是大概文档结构图，左边侧栏的一级、二级、三级、四级标题。
文档的标题就是他的主线，好的文档其标题必定是清晰的。
清晰的第一个原则就是MECE（ Mutually Exclusive Collectively Exhaustive）原则， “相互独立，完全穷尽”，这在麦肯锡工作方法中多次提到。
依据MECE原则，对文档的标题进行组织，理清思路，是文档逻辑框架的最起码要求。
好的文档框架，只看标题就知道作者大概想表达的核心思想。这根阅读一本书，通过阅读目录就能知道梗概是一个道理。
3、文字流畅
这条也确实比较难以描述。有些文档，文字晦涩难懂，碎片化问题严重。各个句子之间没有联系，一看就是句子的堆砌，内在毫无联系。
文字流畅的功底在内功，而非一招一式。
办法就是多阅读，阅读好文章、好论文、好报告，好东西看得多了，才知道什么是好东西。
文档写完以后，推荐的办法就是，写完以后自己读一遍，自己读一遍，自己读一遍。
如果足够幸运，找一个未来潜在阅读对象读一遍，看是否有逻辑不通畅问题，非常有效。
03 外表有颜值的漂亮文档
格式就是一个文档的脸面，给它化化妆再出门吧。
只有被骂过100次以上，才会明白文档格式的重要性，才会形成良好的习惯。
“格式好的文档千变万化，格式不好的文档大同小异”，今天主要说说文档格式的几条大忌。
1、字体与颜色不统一
技术文档的字体比较单一，大都标题黑体，正文宋体，有时正文也用楷体、仿宋等。有些时候，注释用斜体后者其他字体与正文突出区别。英文字体大都用Times New Roman, 或者用Arial。
正文和标题字体可以都用样式进行统一管理，切忌单独调一段字体格式。
其实文档没有强求用哪一种字体进行搭配，最重要的原则就是字体和颜色的使用要有规划，然后保持统一和持续可解释性。
反例：
文档是从其他文档片段摘录，后来估计是选择了“保留原格式”，导致文档格式千奇百怪。字体、行间距、首行缩进均不一致。
PPT的编辑没有用母版视图，所有的PPT单页都是无格式混乱状态，标题的字体和颜色无规律变换，也无法用母版视图统一调整。
2、图和表没有用题注进行编号
对所有图和表的编号用题注进行编号，这是对文档汇总人员的最起码尊重。不要问我题注是什么，也不要问默认题注没有“表”“图”这样的字怎么办，问百度。
反例：
编号不统一：有些图有编号，有些图没有编号
章节号不统一：有的包含章节号，有的不包含章节号。
字体不统一：图表的题注一般默认黑体，10号。要改都统一修改，避免不一致。
3、慎用怪异字体
正式的技术方案中，尽量简洁可能是最耐看的处理办法。慎用不常用的字体，例如华文彩云、幼圆、新楷等。慎用bulinbulin的颜色，慎用大红大紫的颜色。
英文字体比较多，选择一个跟中文字体差不多的样式，保持统一性。
反例：
在正式报告中，为了表示强调，部分文字采用生僻字体，全局不协调
颜色方面，采用大蓝大紫深色系颜色，远远望去像霓虹灯一般，早已看不见下面的文字。
4、慎用下划线
下划线的本意是强调，但在正式的发布文档中，极少用下划线。如果特别想强调，加粗即可。
下划线很容易让整个文档的档次降低，可以参考国内或国外同行发布的权威研究报告，极少看到下划线的使用，大都通过字体和颜色的变换凸显层次感。
反例：
为了强调报告中的图表，特意将报告中图表的标题字号大于正文，不仅如此特意将图表的标题加上下划线。
为了强调一段话的重点内容，对大段字体进行下划线处理。
04
小结
目前，在很多技术人员眼力，文档可能就是花架子，不实用。然而，写好一个文档并不是一件简单的事情，需要内外兼修才行，对一个人的综合能力要求很高。
倘若一个技术团队，大家都遵循一个统一的文档高质量标准，具有缜密的思维，这个团队的战斗力、执行力岂不爆表！
其实只要态度到位、方法到位，人人都可以写出漂亮的好文档。
网友评论