引言
今年跳槽后，开始写了很多不同类型的文档，自己也开始写博客，在这个过程中，我开始重新审视 “Writing”，并且意识到它可能比我想象中要重要很多。当我意识到它的重要性之后，我决定把它写下来，因为在写博客后我有了一个体验，那就是：当我觉得 “我懂了” 某件事，如果我试着写下来，常常会发现还有很多没理清的地方，而写下来能帮助我内化这件事。 这个博客我有两个目的：
- 帮助自己更深刻地理解写作的价值
- 梳理不同写作场景下的思维方式和应对策略
为什么要写作
第一个目的: “sending some message to some audience” 。
这个来源于最近写 doc 时候 manager 的建议，这是个很简单但是又容易被遗忘的目的。特别是在工作写作中，应该要在写之前弄清楚这三件事情：
- 写给谁看？
- 希望看的人从中得到什么信息?
- 希望通过这个 doc 达成什么目的？
弄清之后在写的过程中会少走弯路，重点也会更清晰。
除了传达信息，我个人写作还有另一个目的: 帮助自己思考 。
很多时候，我会以为自己 “大概懂了”，但是只是脑子里有一个模糊的“懂”的印象。而当我开始动手真的把脑子里的想法写出来，我总会发现很多地方我概念混乱，逻辑也不通，并不是真的懂，从而倒逼我去思考和梳理。例如我写 Parallel Decoding 的博客或者甚至这篇博客，都是在帮助自己梳理思维。并不是写完就“懂了”，而是我原本可能只懂了 10 分，但脑子却以为自己懂了 60分，写的过程中脑子会意识到：“哦，其实我只是懂了10 分”，然后在写和思考的过程中慢慢把它补全到 20分，30分。
工作中的一些写作场景
作为一个打工人，我的大部分写作都发生在工作中，我希望用这一 part 梳理一下其中几个典型场景。
Project One Pager (项目立项)
给谁看
- [主要] Manager, TL: 关心这个项目值不值得做，目标以及路径是不是清晰，有没有风险
- 项目参与者: 了解项目背景和设计思路
希望传达什么信息
- Why: 为什么现在要做这个项目。
- Goal: 我们要达成什么目标，有什么收益。
- How: 打算怎么一步步执行, 有什么 milestone
- Risk: 已知的风险有哪些，以及有没有预案 [if any]
- Resource: 需要什么资源，可以是人，也可以是其他支持 [if any]
希望达成的目的
- [P0] 争取支持：希望老板看完之后觉得，这个项目值得做，愿意投入资源
- [P0] 获得反馈：希望老板，TL，或者有 context 的人在早期指出风险，或者更好的执行方案，完善计划
- [P1] 让参与者理解 context：让参与的人快速理解项目背景，目标，计划，减少沟通成本
Alignment Doc (对齐文档)
适用场景
- 当前方案需要更新的，有不同方向需要选择的时候
- 需要其他人配合达成共识的时候
给谁看
- 项目直接相关人员
- manager 等需要知情 Resource 怎么用的人
希望传达的信息
- Status: 出了什么问题
- Options: 有哪些可选路径，各自的 pros/cons
- Recommendation: 自己要有一个倾向的方案
希望达成的目标
- 达成下一步方案的共识
这类 doc 的想法
这类 doc 时效性很重要，不要太追求完美，别拖拖拉拉写一天，最好半小时写个草稿，再半小时完善一下就好了。
Launch Summary (成果发布)
适用场景
项目完成，或者完成阶段性 milestone
给谁看
- manager
- 项目相关 partners & coworkers
- 更广的但非直接参与的 org
希望传达的信息
- [P0]Achievement: 项目交付了什么
- [P0]Acknowledgements: 感谢为项目做出贡献的人
- [P1]Context: 项目的背景
- [P1]How we did it: 中间有什么技术突破，或者有什么值得以后复用的东西
- [P1]Next Step: 有什么后续计划
希望达成的目的
- 宣传成果
- 给参与者 visiblity
Knowledge Share
给谁看
- 同组同事，跨组使用者，未来维护者等
- 未来的自己
希望传达的信息
- What: 解释清楚这是什么
- Why it matters: 它用来解决什么，为什么重要
- How: 怎么使用它
- Reference: 其他资源以便需要更深入理解
希望达成的目的
- 加速他人理解：自己学习或者踩坑以后，别人能通过这个更快掌握这个信息
- 减少重复沟通：节省每个人都要问一遍，或者要回答多遍的问题
- 提升影响力：越多人从中收益，影响力越大，好的 doc 也可以构建 expert 的人设
一些 Tips
- 开头给 TL;DR: 特别是对于一些长文档
- 不要妄想一口气写完美: 先写 draft 再修改。想着“一次写好”容易变成无限拖延，反而写不出来
- 不要忘记目的: 时刻记住自己文档的目的，不要写到一半写偏了
总结
最后，我也是最近才认识到写作的重要性，这篇 blog 肯定写的不够全面。但它已经帮我达到了一个很实际的目标：把我对“写作”的理解，从 10 分梳理到了 15 分。等以后经历更多坑、写更多文档之后，也许会有 20 分、30 分的版本，到时候我再写一篇。