运用六步写作法写 incident review 文档

作者：程序员罗尼 ｜ 发布：2021-02-26 ｜ 原文：https://mp.weixin.qq.com/s/eytAgMuJodFmNND06EbEPg

---

入职一年多，喜提第一个 incident。虽然是最低等级的 incident，影响很小，但是也要做 review，需要准备复盘会议、写 review 文档。这篇文章就简单分享一下我是如何写出这份 review 文档的。

六步写作法

总的来说，写任何文章都可以遵循以下这六个步骤（顺序不是固定的，可以从前五步的任意一个步骤开始写起，步骤之间也可以反复进行，这里的顺序只是我这次使用的步骤）：

1. 组织大纲
2. 思考目标
3. 头脑风暴
4. 思考读者
5. 写初稿
6. 不断修改

这几个步骤是从《完全写作指南》里学到的，感觉很有用，大家有兴趣也可以读一读这本书。

下面把这几个步骤套用到这次的 review 文档上，看看如何写好一篇 review 文档。

第一步：组织大纲

跟书的目录一个意思，可以用列表，也可以用脑图，顺手就好。对于 incident review 文档，公司是有模板的，已经是经过不断迭代之后的稳定版本了，照着规定好的结构写就可以了，所以这一步就省了。

第二步：思考目标

也就是通过这篇文档想要达到什么目的？我想关于 review 文档的主要目的有三个：

1. 把事情描述清楚
2. 这个 incident 暴露了哪些问题
3. 针对暴露的问题，有什么样的改进措施

第三步：头脑风暴

这个步骤的目的就是从上面的目标出发，找到能支撑或者描述相关目标的素材。对于 review 文档来说，可以从三个方面进行思考：一是客观事实，二是根据事实做出的分析，三是由分析得出的结论（也就是云-雨-伞模型）：

1. 整理事情的来龙去脉。从故障的发生、处理，到解决都发生了哪些事情，主要考虑 who、when、what、how 等问题：谁，什么时候，做了什么，怎么做的。
2. 相关的数据、监控、日志等等，各种故障现场相关的信息。
3. 分析其中哪些地方暴露了问题。
4. 思考改进措施。短期、中期、长期都思考一下，找到可以落地的 action。

第四步：思考读者

读者就是相关的 stakeholder。他们希望通过这个文档看到上面目标里提到的几点，但是每个人拥有的背景是不一样的，所以要把背景信息说清楚，让每个人都能看懂。这就要把自己放在各个读者的角度，思考他们知道哪些、不知道哪些，把他们不知道的表达清楚。这里宁多勿少。

第五步：写初稿

上面的都想清楚了以后，就可以开始写文档了。第一稿不要想着尽善尽美，后面逐渐完善。

第六步：不断修改

要知道文章没有一次就能写完的，总要不断修改才能完善。文不加点、一气呵成多数时候是吹牛 X，或者是天才大牛的专属。如果你没有李白的文采，建议还是多多修改。

修改的过程中可能需要不断回顾上面几步，看看哪里不好，针对性修改。修改的过程也就是校对的过程，先自己多读几遍。如果有条件的话，找别人帮忙读一读，提一些建议，可以弥补自己的一些盲点。

写在最后

OK，差不多了，如果这六步都做到，文档肯定不会太差了。

以上就是我根据《完全写作指南》中六个步骤写出 incident review 文档的过程。但是我不希望以后还能用上，哈哈，毕竟搞出 incident 不是什么好事。