撰写开发文档 (如何做一份好的文档)

大家在职场工作,无论哪个岗位,都需要和文档打交道。即使是看上去和文档工作最远的程序员,也需要写技术文档和复盘总结。

职场写文档,例如咨询分析报告、产品设计方案、项目总结文档、年度工作汇报等等,大多数情况下并不要文笔卓著,也不要思如泉涌,而是能理清思路,将自己的观点如实有效的传递给对方,让对方正确理解即可。

虽说现在已经有chatGPT可以来帮忙写作了,但是自我观点的梳理,逻辑分析思考,有条理的表达,都是必不可少且不可替代的。

因此我建议所有职场人还是要学会如何写“好”文档,而不是借由工具来代替脑子,否则不发挥脑力作用的人很可能就会被chatGPT替代。

如何写好文档,怎么写文档

01 什么是好文档?

你觉得什么样的文档可以称之为“好”文档?

职场中的办公文档(以下简称“公文”)和读书时的作文写作有相似,也有差异:

作文通过文字表达情感不一样,公文撰写要解决企业或关键领域问题,或找出关键机会;

作文属于文学范畴,一百个读者可以有一百个哈姆雷特,公文则属于信息载体需要简单一致的完成信息传递;

作文好不好,同学们说了不算必须语文老师或者专业评委说了算;但公文好不好,所有需要阅读公文的读者说了算。

因此在职场写文档,必须要摒弃掉“我就爱这么写”,“我自己看得懂”,“写字太麻烦我用嘴说吧”之类过于自我的想法;

而应该从读者出发,了解读者群体是谁,他们的阅读水平和习惯是什么,再对应的撰写他们能看得懂,好理解,有收获的文字内容。

因此写文档,第一步不是拿笔,而是换位思考。

如何写好文档,怎么写文档

02 写文的意义

文档首先是作为一种沟通载体而存在。

在职场里,有非常多需要沟通对齐的场景,例如需要向上沟通方案思路,所以需要写方案文档;需要横向沟通项目节奏,所以需要写项目文档;需要向下布置工作,所以需要写计划文档……

“写文档太费劲了,把文档写完,我活都干完了,所以可以不写文档吗?”

如果不把要做的事对齐、梳理清楚,很可能做完了才发现做偏了。

把要做的事对齐、梳理清楚的最好办法,就是把它写下来,让写的人和看的人一起对此发表评论,确认是否理解一致。

另外也可能一开始是对清楚的,但是做到一半又模糊了,需要一个记录的载体来查阅当初的信息;遇到争论时,也可以随时把信息翻出来对清楚。

如何写好文档,怎么写文档

其次,把文档写明白了的人,会把文档视为自己的产品。

产品是解决未被满足问题的方案。

写文档就是来提出一种方案,解决公司或某领域未被解决的问题,或发现解决新问题的机会。

把自己想做的事条理清楚的表达完整:为什么要做?做什么?怎么做?自然就能获得更多人的理解和支持,这件事就有可能被推动起来。

03 写文的系统思维

写文时,需要有三种关键思维:逻辑思维、细节思维、长线思维。

1. 逻辑思维

什么是逻辑?

逻辑不是思维,

逻辑是思维的规律,人类有且仅有两种逻辑方式,归纳法逻辑和演绎法逻辑。

如何写好文档,怎么写文档

归纳法是对现象的总结,例如根据以下信息可以得出“多国坦克已抵达波兰边境”这一归纳结论。

如何写好文档,怎么写文档

演绎法是对现象因果的推论,例如根据以下信息可以得出“苏格拉底会死因为他是人”这一演绎结论。

如何写好文档,怎么写文档

看起来演绎法难于归纳法,因为演绎法需要先有一个系统假设,而系统假设就像数据公理一样难以提炼。

但实际上我们普通人可以直接套用已被总结提炼出的现成规律来作为演绎法的前提假设,再把具体场景带入,自然就能得到演绎结论;

而归纳法则不仅仅是要得到复数名词形式的概括,而是要从中抽象出有意义的推论,即不仅仅得出“多国坦克已抵达波兰边境”,而是“多国军事力量支援波兰”的归纳推论。

关于逻辑思维的深度讨论我会在后续单独章节展开,这里就不多讲了。

2. 细节思维

什么是细节?

细节不是细小的局部,

细节是容易被忽略的关键事物。

构成事物发展的每个环节都很重要,但是其中容易被常识忽略的,就是细节。

例如所有酒店基本上都会在房间里放两瓶水,但是如果有一家酒店选择放三瓶水,旅客就会觉得这家酒店特别人性化,这就是客户体验的细节。

又例如我们在淘宝上买衣服很容易买到仿版,但当你拿着买家照要和卖家理论时,又说不清具体差在哪里。实际上品牌产品与普通产品的差异就在细节上。

如何写好文档,怎么写文档

在写文时,细节体现在术语定义、语句检查、标点符号、风格统一、先后无歧义……

例如术语定义是指第一次出现的专有名词或英文缩写,都需要解释清楚词语意思。

我曾经入职一家公司,收到的工作文档中经常会出现未定义的英文缩写,即行业黑话。

可能写文档的人非常爽,一方面不需要仔仔细细的这标注下那解释下,另一方面还能凸显自己在某领域的专业性。

实际上这样的文档给人的感觉非常排外,要读懂这篇文章必须要先全面了解该行业内的专业知识,或者读到一半叉出去百度百科上搜索意思才能继续阅读。

即使这篇文章只面向同领域内的专业人士,但同一个专有名词对于多个行业专家可能都会有不同解读,因此必须在首次提到时做出自己的标准定义,将讨论范围限定在同一个频道内。

3. 长线思维

什么是长线?

长线不是放长线钓大鱼,

长线是指为了实现长期目标,反推出的长期行为策略。因此我们常说的延迟满足、长期有耐性,厚积薄发等,都是长线思维的变形表达。

如何写好文档,怎么写文档

长线思维作用在写文中,就是必须先用全局视野定好框架结构,根据章节安排撰写计划,如有一处改动则进行全文检查,前后埋线要呼应……

04 写文的常见问题

没有经过写作训练或养成以上三种写作思维,写出来的文章经常会存在以下三类问题,这些问题都会让读者无法理解和认同作者观点。

1. 字句模糊

即读者读不懂文档中某些字句要表达的具体意思。

直接原因是写作者语言语法不扎实造成语病,或忽略了需要提前告知的必要前提。

本质原因是缺乏换位思考的沟通意识和细节思维,可以采用大量语言练习、有意识的语句校验、写短句而非长句、同行交叉检查、外行阅读提问等方法来加强。

2. 结构不清

即读者对文档整体和结构没有形成有效映象。

直接原因是写作者表达思想时采用的逻辑方式与读者的理解方式产生了冲突。

本质原因主要是逻辑思维不足,可以在理解心理认知模型后,进行结构化写作训练。

如何写好文档,怎么写文档

3.缺少连贯

即文章前后风格、顺序、承接,甚至逻辑上存在混乱、矛盾。

直接原因是写作者缺乏整体架构梳理,或在撰写分工时没有统一思路。

本质原因主要是长线思维不足,可以在写作时理出整体架构:对目录、风格、标准进行约定,如多人协作必须把写作思路和标准传递给所有协作者,最终统一汇总和修改检查。