技术类写作模板——问题复盘

2023-04-17

【技术类写作模板】[xxx]问题解决复盘

​ 作者:stevetao 时间:2023.03.03

此类技术博客写作要素:

1、问题背景: 如何发现的问题?在什么情况下发生的?造成了什么样的影响?

2、排查过程: 针对展现出来的异常,需要做一些测试来验证,整个过程就需要不断的测试、研究、推断、验证。(问题排查过程,逻辑分析和推理,这些也是此类博客的亮点和难点,写清晰了会是高质量的技术文章)。

3、解决方案: 根据上一个步骤找到的问题本质,在这个步骤中去解决,总结有哪几种解决方式,最后采用了哪种解决方案。

4、问题防止: 解决问题之后,总结经验教训,防止下次此问题再次发生,采用了哪种监控措施和应对措施。

结合图片、code 。

1.1 xxx问题背景

(是什么)

1.1.1 现象描述

(交代清楚现象、条件环境、影响)

1.2 分析处理

1.2.1 原因分析1

(根据现象推断产生原因,结合技术知识点,分析推断)

1.2.2 制定解决办法1

(根据1.2.1中的推断结果,制定处理方案)

1.2.3 执行操作1

(执行处理方案,查看现象,问题是否得到解决?还是引发新的问题?)

1.2.4 验证1

(根据验证结果得到结论:A、问题解决 B、问题未解决。A结果直接到复盘环节;B结果,重复1.2.1的流程,直到问题解决。)

1.3 问题复盘

1.3.1 总结

总结问题涉及到的知识点、原理。

简洁概况一下,问题发生的原因;解决方案;

思考一下问题是否完全杜绝了,还是会引出其他隐患;