“这是一场单口相声的战斗,长官,还是一场虫子狩猎?” - 哈德森
我一直想知道编写出色的错误报告的秘诀是什么。随着时间的推移,我将活动范围缩小到三个基本要素。
- 复制:一旦你找到了错误,复制它。
- 文件:写下来,必要时详细打包。
- 沟通:将其输入错误跟踪器并告诉某人。
复制- 显然这是最讨厌的一步,因为你刚刚破坏了一些东西,我们为什么要再次破坏它?不幸的是,这是过程的一部分。可重复的错误通常会让开发/实施团队非常清楚地了解可能出现的问题。一次发生的错误可能很难追踪。所以,如果你发现有问题,你的第一步就是尝试让它再次发生。这就是为什么你在精神上跟踪你在做什么和你点击了什么是至关重要的。某些组合会产生错误,而其他组合则不会。
文档- 唯一比错误更糟糕的是没有任何细节的错误。例如,以下错误报告有什么问题?
我的订单失败了。我认为它坏了。
除了您的订单失败之外,没有任何细节!非常出色的细节示例:
- 重复错误的步骤(参见步骤 1)
- 你所期待的与你得到的
- 出现在页面上的错误消息
- 您使用的是什么浏览器/操作系统
因此,如果您要像以下那样重写错误 - 这将使实施团队更容易调查和解决问题:
我正在使用以下内容: 操作系统:Mac OS X (10.4.9) 浏览器:Firefox 2.0.0.3
我在 yoursitehere.com 上订购的依偎小狗无法通过,我不知道为什么。当我尝试下订单时,我最终在订单输入页面上显示以下错误消息:“我们很抱歉,我们的记录表明已经下了另一个订单....”带有确认消息的收据页面和我的收件箱中的确认电子邮件,但我收到了错误消息。
尝试以下步骤:
你的步骤在这里
沟通——为了纠正错误,实施团队需要了解它。这并不像听起来那样乏味。但是,您越早让您的主要开发人员/项目经理/测试人员知道,它就可以越早进入队列进行修复。
我就是这样做的……但是在你的脑海中是什么让一个伟大的错误报告?