一家之言。
1. 前言
近几年一直在公司内部推进组织过程资产积累，沉淀项目经验的相关工作。而文档作为资产沉淀的重要手段，一直处在推广的最高优先级。
本文尝试总结在编写文档过程中的一些个人经验。方便形成统一认识，减缓文档阅读难度曲线，降低沟通交流成本。
2. 格式
笔者习惯于将文档分为「标题」，「摘要/前言」，「主体内容」，「总结」，「其他」；以形成思维定势，用习惯来代替毅力进而减少无谓的 自控力消耗。
2.1 标题
一个好的标题对于文档的重要性不言而喻，君不见充斥网络的「UC震惊部」，「你不能不知道的XX」等等，被广大网友唾弃的表象下却是日益严重的同质化，果然是谁也逃不开"真香定律"。
一个好的标题基本要求就是要在表述清晰的前提下尽量精确，缩小范围。尽量避免"XX总结"这种大而不知所谓的内容。
标题不需要在一开始的时候就确定，你甚至可以在写完全篇之后再最终确定文档的标题。
一个好的标题可以让读者以最快的速度确定你的文章里是否有他所需要的内容，打开你这篇文档的人一定是和你有着类似疑问的朋友，你们将站在类似的场景下进行交流，这能帮你省下大量准备前置知识的时间。
2.2 摘要/前言
之所以将两者并列，毕竟我们不是在写论文，我们编写文档的目的是将我们想要传达的内容以最快的速度让对方理解并应用。因此对于摘要/概述或前言，大家可以根据自己的习惯选择其一即可。
总体而言，摘要/概述的编写难度要高一些，所以笔者个人更偏向于使用「前言」来在开篇介绍背景，让读者能够快速了解上下文，进入角色。
这一部分在紧抓重点，描述清楚场景的前提下，要尽量减少字数，降低读者的阅读压力。
2.3 主体内容
这部分的内容主要还是由文档编写人员自由发挥，基本准则是根据实际要论述的内容进行分段，不断切换阅读者和编写者的视野来完成该部分的内容，这要求文档编写者掌握跳出自身视角，用读者的视角来组织主题脉络。
这一部分就笔者自身来说尚未有成体系的经验，这里就不班门弄斧了。
2.4 总结
在写完文章的主体部分之后，基本这篇文章算是完成大半了，但这个时候切忌掉以轻心，还有几项非常重要的工作要做，首当其冲的就是编写「总结」部分。
编写「总结」部分，首先是给读者一个文章将要结束的信号，让读者能够较为平缓地从场景中脱离出来，当然也是帮助读者更全面和快速地了解整篇文章的脉络和重点，做到有的放矢。
总结部分的编写一个更大用途是它会倒逼你去反思整篇博文的主线，进而帮助你优化整篇文章的结构和表述，这样将来在自己回顾和审视全文时能够快速抓住文章的关键点。
2.5 其他
在"总结"部分编写完成之后，你还可以做一些其他润色性质的工作：
- 你可以在文档接下来的部分附上你在编写本篇文章的过程中参考了哪些资料，甚至可以为每篇文章单独附上一两句说明性文字，这既是对于原作者的尊重，也能增加文章的说服力，更是方便了读者以及将来的自己。
- 你可以写下一些自己对于所编写内容的自身感想。算是将理性部分和感性部分进行分开论述，做到"职责单一"。
3. 最佳实践
3.1 始终站在读者的角度
这不仅仅是为了增加文章的阅读量，获得认同感。也是为了几个月后的自己，文字是对思维的总结，如果此刻写下的文章不能给将来的自己一些帮助，那还不如去打几把吃鸡。
3.2 形成固定的格式
将文章排列形成固定的格式有助于形成思维定势，使用习惯代替毅力进而减少无谓的自控力消耗。正如上一小节说明的，笔者个人基本就是参考这个格式来进行的排版，这样可以将节省出来的精力用在更加值得花费的位置，例如排版，例如所研究内容的深化等等。
3.3 注意排版
文章的好坏，一方面在于内容，也就是所谓的"干货"，另外一方面就是排版了，以下给出笔者的一些个人经验（更详尽的参见笔者底部给出的链接）：
- 注意分段，每段不要太长。避免出现一段话直接喘不上气的情况。
- 不要用过长或者过于复杂的句子和措辞。
- 避免使用多重否定句式。
- 适度使用颜色和加粗来强化/突出重点。
- 重视空行的作用。
- 层次化内容。通俗点说就是列表的方式来排列内容，但要注意这个层次不要太深，一般两层基本就是极限了。
- 文不如表，表不如图。虽然画图相较于文字更加耗时，但好处不言而喻。
3.4 反复打磨
罗马不是一天建立起来的，世界也不可能完美，所以我们要秉承一颗开放并且不急不躁的心态，将文章写出来，然后慢慢优化，最终成文。
4. 我为什么要这么辛苦？
相信看了以上内容的读者能够想象其中的强度，自然而然如小节标题的疑问就出来了。
这里笔者给出的个人理解是：所谓的进步，大概就是在那些绝大多数人认可，但又不愿意行动的方向上，慢慢前行吧。
网友评论