Skip to content

INFO

参考最佳实践:字节跳动优秀文档 8 大秘籍

适用场景:

写文档前,参考以下问题梳理思路

写文档后,结合以下清单自查优化

Why - 目标

问题答案
* [ ] 要解决的核心问题是什么?> 一句话说清楚核心问题
* [ ] 我的核心观点和建议是什么?> 我的核心判断是什么?不超过 3 个要点

2. Who - 读者

问题答案
* [ ] 目标读者都有谁?> 谁是最重要的读者
* [ ] Ta 们知道什么?> 有哪些背景信息,我需要让他们也提前理解? > 他们可能知道哪些额外信息,可对我提供帮助?
* [ ] 他们最关心的点是什么?> 每个角色,提炼最关心的点,如 * 决策者:方案全面性、ROI、关键建议与风险 * 协作者:对业务有什么影响和收益,需要我配合做什么 * 信息同步对象:知道最关键的信息即可

3. How - 结构

问题答案
* [ ] 文档整体结构是否清晰?* 参考金字塔原理来构建 * 文档目录一目了然,可以快速定位重点 > image
* [ ] 关键结论是否前置?> 最关键的结论前置在前面,再展开细节

4. What - 内容

突出重点

问题答案
* [ ] 关键结论是否前置?> 最关键的结论前置在前面,再展开细节
* [ ] 段落要点是否醒目?::: 可使用文档的高亮块突出重点 :::
* [ ] 复杂问题,可否用图表清晰描述?> 一图胜千言,这个问题,用流程图、表格图表📈画一下,会不会更好理解?

精简内容

问题答案
* [ ] 有哪些信息读者已经知道了,可以不写或简写?> 能少则少
* [ ] 是否可以提炼为几个要点?> 人的记忆条目是 7(±2)条,归类之后会减少人的记忆成本
* [ ] 如果去掉这部分,是否会明显出现信息的减损?> 如果答案不是一个肯定的 Yes,那就是一个肯定的 No

清晰表达

问题答案
* [ ] 是否用了一些黑话和高深词汇?> 一个简单的参考标准是:“新同学能读懂吗?”
* [ ] 读者可能会有哪些疑问?> 读者看到第一句话所产生的疑问,下一句话就给 ta 答案

格式检查

问题答案
* [ ] 对齐> 标题、正文、图片、表格对齐
* [ ] 错别字> 中英文都检查下,避免同音词、拼写错误
* [ ] 标点符号> 大小写、全角/半角标点、单位保持统一、数字小数点

不断迭代

问题答案
* [ ] 是否可以提前发给同事看看?> 收集下其他人的反馈
* [ ] 公司内、互联网上,有哪些好文档可以参考学习> 他们写得好的原因是什么,提炼下思路复用
* [ ] 上次的文档,大家给过哪些反馈> 同一个坑,不掉两次