公众号：杨建荣的学习笔记 · 作者：杨建荣 · 发布：2018-07-11 23:59:15 · 原文链接

    最近看了以前写的文档，发现改进空间其实很大，这里要说的不是文档的编排如何，而是文档的质量，就好比文档是一盘菜，你至少得看到菜品，通过文档闻得到“味道”。

    为什么我们不重视文档，其实很多时候就是因为文档很多时候会流于形式。一旦流于形式，那么就逐渐得脱离了参考价值。所以现在更直接的一句话说：talk is cheap,show me the code.

    当然我在这里不是为文档工作唱赞歌，而是我们对于文档中的Design的部分，其实可以做得很好。

    举个例子，对于一个产品，其实哪怕是一个界面，其实给你一天的时间，你肯定会联想到更多的改进之处，哪怕是图标的颜色或者大小甚至字体。因为前端呈现出的是一种交流的形式，我们好比在和软件在聊天交流。

    有的软件页面很生硬，但是后端设计很好，这就会对已有的产品大打折扣。

有的产品前端很好，后端没有什么逻辑，这种很虚，简单点说就是没有内涵。

    那么这里的design是什么呢，或者说很大外企在提倡的design是什么呢。

    其实这个部分不是详细的设计，而是需求和设计思想的结合，或者说我们也可以叫做概要设计，在实现程度上，可能比概要设计要详细一些，就是介于一种平衡的状态。 

    很多时候，其实我们有很多的想法，一个是没有表达出来，要不就是没有展现出来，和表达出来相比，能够展现出来是更好的。一个产品的设计，如果有一个简洁整齐的图形来表达，那比大段的文字明显要好很多。另外一个我们有很多的思想，其实通过口头表达很容易被遗漏，不要相信很多讨论中信口开河的想法，我们生成一种文档的形式来记录，哪怕是一些不成熟的想法。其实有些地方挖掘或者引导就可能是一种全新的结果。 

    所以这里的Design就是要表达的是一种思想，通过表述把思想和流程结合起来。为什么我们的很多系统或者设计不好，因为还没想明白就陷入了详细的实施阶段，结果发现做得时候漏洞百出，如果这些你能够提前整理，那么你一次安装100个软件包，和分为100次安装100个软件包显然效果和体验是不一样的。

    一旦design陷入详细设计，之前没有想明白就会发现，我们开始被各种细节锁纠缠。具体去做的时候才去想该怎么实现，这是个很不好的习惯，我在这个地方吃过很多的亏，也积累下不少的技术债，换个思维来说，我码了很多代码，发现最后可能入手点就错了，然后反反复复修改，最后的结果竟然和预想的差别很大，于是委屈求全。

    还有一种形式，那就是我们忙活了一场，结果要展现的时候发现才要开始整理文档，整理的过程必然是痛苦的，那么为什么不可以变成一种更加好的体验。

    在我看来，文档的意义和价值，设计文档的时候要全面，要有流程，多图和理念，不断完善和改进，而实施操作的文档，一个简单的衡量标准就是你能够看着文档从头到尾很顺利的做出来，不求形式，但求结果，至少你对文档是认可的，否则就干脆不要写了。