问题记录框架
平时开发工作过程中,总会遇到一些值得我们反思和总结的问题。把这些经验教训以文档的形式记录下来,形成文档存档到知识库中,是一件非常有价值并值得去做的事情。大家都会做总结或记录,然而,如果没有统一的一种文档规范格式,大家的总结记录文档的内容组织格式可能多种多样。为了形成更统一、清晰的问题记录文档,个人根据实际工作中的问题记录,提炼出下面的问题记录框架。
问题记录框架结构包含以下七个要素:
- 问题名称
- 问题现象
- 影响范围
- 原因分析
- 解决方案
- 实施策略
其中,问题名称、问题现象、原因分析和解决方案这四个要素是必须的,也就是说,每个问题记录文档中必须包含并描述这四个要素部分。其他的要素不是必须的,可根据具体问题酌情补充。
为了方便、快速的查找问题记录文档,也制定了一个统一的文档命名规则,文档名称包含问题记录日期以及问题简要描述,如下:
命名规则:yyyyMMdd-问题名称.md
- yyyyMMdd:该问题的记录日期
- 问题名称:针对该问题的简要概括描述
问题名称
给该问题取一个具有描述性的名称,简短精炼,包含问题核心关键字。
问题现象
描述问题发现的日期,该问题由谁那边发现和反馈的,并详细描述问题表现出来的现象。此处重点在于描述问题的现象,要如实而准确的记录,不要做假设性描述。
影响范围
评估该问题可能造成的影响范围,比如核实从哪个软件版本引入该问题,该问题的严重程度,涉及影响的终端设备批次和数量是多少,等等。
原因分析
详细描述问题的分析过程。通过收集相关数据、分析、验证,找出问题的真正原因,并以准确的语言条理清晰地描述出问题产生的原因。
解决方案
描述针对该问题的具体解决方案。需要给出该问题可能的一些解决方案,以及每个解决方案的优缺点。对于有两个或两个以上的解决方案,需要给出权衡各解决方案的考虑因素,并最终决定采用哪个解决方案。
实施策略
描述该问题解决方案的具体实施步骤,需要协调的资源,以及需要花费的时间等各个因素。