Louiscard | 吕江涛 : 「大厂文档写作指南」:如何写出高质量的业务文档?

本文转自: https://louiscard.com/2024/12/01/big_company_docs/
仅做个人收藏,版权归原作者所有

这篇文章聊聊对于文档写作的理解,特别在大厂,写好一篇业务文档需要注意哪些关键点。

写好文档的重要性

在亚马逊、字节、美团等公司的「反 PPT 文化」的影响下,文档的重要性被更多组织认识到,像得到-App 等平台也推出职场写作课等产品,帮助职场人士提升写作能力。为什么写好文档这么重要呢?

  1. 更容易拿到组织的资源和领导支持:文档写得好,Leader 更可能接受你的主张。这样你能拿到更多资源,增加项目成功的可能性。
  2. 节省沟通成本,提升信息流转效率:文档给的信息清晰充分,很多沟通完全可以异步完成。不少同事还会写一篇「说明书」文档,贴到签名档,提醒大家找自己沟通前先读文档,高质量的文档,能减少大半的重复沟通。
  3. 有规模效应,创建个人和团队品牌:文档像社交媒体的文章一样有自传播属性,公司一些优秀的文档能获得几万阅读,上千点赞,一些优秀的项目文档被长期传播,文档是讲好个人和团队故事的好工具。
  4. 体现个人沟通能力和职场专业度:见字如面,相比 IM 聊天和开会,更多人会通过阅读你的文档对你的能力和职业度进行「打分」,看到写得干净利索,条理清晰的文档,绝对高看一眼。

如何才能写好一篇工作文档呢?我在这里提供以下几点建议:

更有用户视角

打造一款产品, PM 会被无数次提醒「用户需求」,写文档也应如此,写文档同样应关注用户需求,我们需要理解需求视角和供给视角,始终以用户需求为核心,从文档撰写开始就紧密围绕用户视角,识别、深挖用户的各种需求。

写文档最大的问题就是只关注「供给者角度」,忽视用户视角,不关心读者关心什么,知道什么,不知道什么,而只关注怎么把自己的关键点呈现完整。这就会导致读者过高的阅读成本,甚至无法准确理解文档希望传达的重点信息。

比如我们准备一篇季度会的业务总结文档,读者包括团队管理者、协同团队、其他部门,每一种角色的需求不同,有些人就是大概了解,有些人需要关键洞察,有些人需要拿到规划方向,我们能否说清楚他们的需求,并在文档中有意识的满足直接决定文档的水平。字节某大佬提供了一个非常精彩的观点,他指出业务总结文档应该包含三个维度:

  • 维度 1:业务主线,概括性质的东西,偏粗线条,这是业务负责人每天都要关注的关键指标;
  • 维度 2:从某一个或者几个维度对业务的 Break down,让大家看到业务增长/下降的归因;
  • 维度 2.5:选择一个最值得拿出来说的单点,往下钻,展开来说,增加信息丰富度,传说中的「万历十五年」,以小见大的时刻。

这三个维度的信息能比较充分的为不同读者提供足够的信息,也不至于陷入过于笼统或者过于琐碎的细节中。不同公司和不同 Leader 的思考模式会极大的影响文档风格,例如,亚马逊的文档关注可影响要素;Meta 则侧重于数据报告和实验结果;而 Google 的 OKR 已成为一种独特的工作方式。

如何获得用户需求,除了有意识安排用户访谈、组织会前的问题收集,会后的反馈收集,花更多时间跟你文档的「用户」在一起,多吃饭,多聊天,了解他们关心什么,可能更重要。

注重结构呈现

好的结构对于读者的阅读体验至关重要,屏幕阅读时代,大部分人的阅读模式都是 F 型动线,先扫视顶部横线,再沿左侧垂直扫读,没有结构的文档,读者无法通过扫读的方式快速获取信息,只能逐字逐句,效率低,体验差。

文档结构分为内容结构和呈现结构,内容结构的几条重要原则如下:

  • 结论先行:先说结论,再做解释,让读者一开始就了解你的立场和观点;
  • 以上统下:上层结论是概括总结,下层信息具体解释和说明,遵循金字塔结构;
  • 归类分组:把类似或相关联的信息,找到一定标准做划分归类,清晰呈现;
  • 逻辑递进:把信息按照逻辑逐步展开,时间顺序,角色顺序,层级推进等。

呈现结构则多用下面的样式,让信息呈现更清晰完整,相比 100% 的叙述性表达,下面的结构呈现让读者更轻松获取信息:

  • 无序列表;
  • 有序列表;
  • 表格;
  • 图表。

不过对于结构化的表达需要持续积累,一些优秀的文档的结构得有意识积累和学习,你可以去公司的 wiki 看看历史文档,也可以去飞书和 Notion 等文档应用的模板中心,里面也藏了不少宝藏。我前段时间特别痴迷亚马逊的 6 页纸备忘录,网上还能找到几篇示例,从中能看到他们对于信息呈现的思考和设计,很有意思。

亚马逊 6 页纸的结构之一亚马逊 6 页纸的结构之一

简洁清爽表达

这其实也是注重用户视角的表现,没有读者喜欢阅读诘屈聱牙,长句套短句的复杂文档。尤其是工作文档,风格要追求简洁和清爽,用大白话,避免黑话和术语,一些需要注意的关键点我也做一些罗列:

  • 避免口水词:比如「的」、「我认为」,「事实上」;
  • 避免形容词:比如「好」 → 「达到预期指标/完成目标/符合验收标准」,「很多」 → 「238个用户/增长53%」。
  • 直接用动词:「便捷性提高」 → 「产品更易操作」。
  • 更简单表述:用肯定代替否定,主动代替被动,「由于 xx 原因」→ 「因为 xx」。
  • 避免长难句:长难句拆解成多条短句。
  • 不用大概念:除了营销,内部沟通不用「深化改革」这样的大词。
  • 不含糊其辞:比如,「尽快完成」→「12月20 日前完成」

可能更重要的一个技巧就是 —— 控制篇幅,我前段时间跟亚马逊的朋友请教 6 页纸的结构,他给了说了一个非常有意思的说法,其实大多数文档都不会 6 pages,而是 one page,因为现在数字化的文档不会打印出来,很多题目里写着「某某项目 onepage」的文档,打印出来怕是要有 10 页不止。(微笑

最后的话

我刚毕业那会去了党政机关的办公室,核心工作就是写稿子,那时候机关单位的小伙伴见面聊天,总免不了提起几位年纪轻轻便扶摇直上的政治明星,那些被人口口相传的故事主角,大比例都是因为写得一手好文章,成为了单位的笔杆子,因此获得机会,破格提拔,火箭晋升,但这不比其他,免不了点灯熬油的下一番苦功夫。

当然在体制外,我们不称之为「文章」或者「稿子」,更习惯称之为「文档」,本质相同,

上文提到的那个字节大佬在分享写双月会文档 tip 的文章结尾的最后一句话让我读了一遍又一遍,也送给大家:

祝大家从此不再受双月会困扰,把 6 月过成夏天而非 Q2。

年底了,又到了写文档的高峰期,也祝大家能因为上文的一些小技巧,多少能少受些文档的困扰,享受这个 12 月的初冬。最后,你在写文档时有哪些心得?也欢迎在下方留言与我们分享 ~