如何快速的写完一篇文档

文档是想法表述的一次阶段性的快照,它是 7*24 小时的活广告,

也是迭代自身想法的参考资料。


我在日常工作过程中,看到很多人不擅长写文档,

一篇文档的完成时间通常是以「天」来计算的,

而我自己通常能在「一小时之内」把文档写完。


这会导致一种很奇怪的现象,在做软件项目的时候,

在我看来,文档就是随手写完的事情,

但是在某些人的规划中,甚至安排了项目结束前一个星期专门写文档。


我觉得值得花一些时间来介绍,怎样才能快速把文档写完。

为什么需要文档

软件项目的从业者们,应当几乎每个人都听说过 “敏捷开发” 的词汇,

但是真正抓住敏捷思想,或者真正能落到实处的,却少之又少。


这可能是很多人在看到专业术语时,仅仅从 “字面意思” 或 “只言片语” 来理解。

并没有抓住这个术语的发明者,到底想传达什么想法。


敏捷宣言中提到,

工作的软件 胜于 详尽的文档


这是一个比较,指的是,与其有详细的文档,不如有工作的软件。

但并没有说,详尽的文档不重要。


要想写出好的文档,首先应当建立 “正确的文档观”,

我们就应当写出好文档,能写出好文档的人,就是强。


只有当我们重视并尊重一件事情的时候,事情才有好转的可能。

为什么写的慢

在介绍如何能快速写完之前,我们可以先来看一下,

写完一篇文档需要做那些事情,以及是什么阻碍了文档被写完。


主要有以下几个方面,我们逐个来讨论原因,

  • 不想写,拖延

  • 不知道从哪里开始写

  • 写的不好

1. 不想写,拖延

产生这种想法的原因,一个如上文所述,没有意识到文档的重要性和必要性,

另一个,则是对事项的交付缺乏进度意识。


古语说,“账多了不愁,虱子多了不咬”。

当有很多 “债” 压在自己身上时,就什么也不想做的。


这时候要解决的问题是,如何克服 “拖延”,如何让自己行动起来。

一个比较有效的办法是 “立即做”。

把手头上的事情,赶紧交付出去,不要堵在自己这里。


实际开始执行之后,就会发现,实际的困难远比自己想象的小。

真正开始做了,就发现其实不难。


当自己转起来之后,输出文档,也就变成了顺理成章的事情了。

2. 不知道从哪里开始写

当我们决定开始写一篇文档的时候,通常会出现 “无法下笔” 的情况,

第一句话到底怎么写呢?


产生这种情况的原因在于,我们自己的素材库中,缺少 “模板”。

或者说是,在阅读别人文档的时候,忘记学习对方的 “思维框架” 是什么。


在表述一个特定问题时候,人们都是有套路的,

自己不知道如何表述的原因在于,别人在表述类似问题时,

只忙着去阅读了,而忘记思考 “他是如何表达出来的”。


一个 “文档熟练工” 是如何写文档的呢?他们总是会先从一个框架开始。

例如,与一线开发打交道比较多的是,方案介绍文档,最常用的套路如下:

  • 背景:为什么会有这篇文档,问题的现状是怎样的

  • 目标:预期是什么,哪些人的预期

  • 问题:现状是怎样不满足预期的,冲突是什么,痛点是什么

  • 方案:为了解决问题有几种办法,为什么选其中一种


有了这个思维框架之后,我们只需要 “填空” 就行了。

3. 写的不好

在写文档的时候,经常会出现,写了一段话之后发现,不是我们想要表达的意思。

原因在于,我们还不适应用文字来表达想法。


用语言和用文字表达想法,是不一样的,

语言多数是张口就来,缺少明确的目的性,主要以 “情绪沟通” 为主。

而文字更多的则是想好了再写,是摆事实讲道理,需要有一定的逻辑严密性。


所以文档更讲究来龙去脉和思路,更讲究事情的前因后果。

正是因为如此,有些人也会用文档来整理思路,迭代自己的想法。


那么如何才能习惯用文字来表达想法呢,办法是,经常性的把自己的想法记录下来。

有时候想到了一两句绝妙的想法,那就赶紧记下来,

并且,经常性的回顾这些小想法,思考这些想法的来龙去脉。


这样有助于形成从知识点,到知识脉络、体系的建立。

当我们有了知识体系之后,逻辑就会变得更加清晰,

很容易完成从一个结论到另一个的结论的推导。

怎样快速写完

说了这么多之后,我们可以正面阐释到 “如何快速的写完一篇文档” 了。

  • 不要拖延,想到了就赶紧写

  • 采用思维框架,来开头

  • 注重结论的逻辑关系

  • 快速交付,让擅长写文档的人,完成后 20%


前三个在上文已经介绍过了,后面我来介绍至关重要的第四点。

有很多人在写文档时,认为这是自己的工作,所以必须尽善尽美才可以交付。

其实不然。


跟大多数需要协同完成的工作类似,其实交付比完美更重要。

文档跟代码也是一样的,是一个持续完善,持续改进的过程。

写得差不多了,就赶紧交付出来,不要自己闷头打磨。


这是因为大部分事情,前 80% 都是容易完成了,后 20% 往往很难。

我们不如将还未尽善尽美的文档,先抛出来,看看大家的想法,

有了这次交互之后,对最终完成文档,帮助非常大。


实际上,前几步如果自己写的实在费力,或者卡顿严重,

同样可以抛出来,交给文档写的更好的人,问问他们的思路。

并不是所有事情都得自己一个人完成。

结语

以上,就是关于 “如何快速的写完一篇文档” 的思路,除了思路之外,

还需要进行大量的练习,比如经常性的写一些心得体会给自己,

经常性的,写一些项目总结给自己看。


这都会有助于积累素材和思维框架,也有助于帮助自己复盘思路,

迭代自己的想法,

我们会发现很多想法不是突然就有的,而是源于之前的一个想法。


只有勤学多练,不卡在自己这里,才能充分发挥出文档的作用。

它就像成为了自己的分身一样,

7*24 小时不间断的,为其他阅读者传达自己的想法。


这可能就是十倍工作效率的秘诀,文档可以屏蔽绝大多数同步的沟通,

可以避免自己被打断,让自己的思路沉淀下来,

帮助自己是思维更完整,让自己成为更好的自己。