编写优秀Bug报告的艺术

时间:2024.5.2

编写优秀Bug报告的艺术

在99年的Quality week上的一次演讲中,微软的一个测试经理,Roger Sherman指出了由于“不可重现”导致bug关 闭的主要原因。这是一个非常可惜的情况,因为这样的bug report浪费了紧张的开发计划中的宝贵时间,增加了对产品质量完全是无关紧要的事情,同时导致了在开发人员和测试之间的挫败感和差的感觉。有 时,bug report是由于短暂的或随机的事件,测试和开发之间不一致的工具和配置,或者在测试的环境下对正确的行为的模糊定义而产生的,但是许多的由于不可重现 而被关闭的测试报告是因为描述不清晰,被误解,或者只是文字的错误。

幸运的是,我学习到 一些能够引起管理层注意,更清楚的和开发人员沟通并得到修复的编写优秀bug report的诀窍。这些技巧不仅仅提供了是在被修复的问题的比例方面得到了可靠的回报,而且在同开发人员和管理层的通过中也得到了回报。在我管理的项目 中使用这种方法编写bug report,8份bug report中大约只有一个没有被修复。

这篇文章的思想只有当你的报告针对的测试执行过程是专业的质量工作才可以发挥作用。聪明地执行完整的测试包是产生可靠的测试状况信息的基础的其中一个因素。在许多的测试文献中广泛地介绍了多种多样的关于如何构建这样的测试包的方法。选择和你质量风险管理需求相一致的技术并且使之适应你的具体情况,敏捷地监督已计划的测试的执行过程,这样你就可以拥有可靠的测试执行过程。

另外一个关键的因素-bug report,却没有得到太多的关注。这是非常令人遗憾的,因为优秀的bug report对反映测试小组真实的和可理解的工作质量同测试本身一样都是非常重要的。试想一下:如果你不能用开发人员能够理解的术语和能够用于调试的方法 给开发人员解释一个错误,他怎么能够修复问题呢?如果你不能够在bug report中提出象“保险杆标签”(bumper sticker)一样的错误总结来引起管理层的注意,你又如何让他们关心你们发现的问题呢? Bug report的核心是对错误的描述。表格1中是一个关于好和差的错误描述的例子。编写好的bug report是一种好的艺术形式。采用以下的10条技巧可以帮助你的小组提高编写bug report的质量:

组织Structure:测试人员应该采用深思熟虑的,小心谨慎的方法执行测试,并且做详尽的记录。这样可以促使他们对测试下的系统有很好的认识。当错误发生的时候,一个有组织的测试人员能够知道最早出现问题的地方。

重现Reproduce:测试人员在编写bug report之前必须在检查问题是否可重现。如果错误不可再重现,仍然应该写下来,但是必须说明问题的偶然性。一个好的处理原则就是在编写bug report之前反复尝试3次。

隔离Isolate:在尝试编写bug report之前,必须试着隔离错误。可以采用改变一些变量的方法,如系统的配置,它可能可以改变错误的症状。这些信息可以为开发人员着手调试提供思路。

归纳Generalize:在测试人员发现了一个已隔离的,可重现的问题后,应该对问题进行归纳。同一个问题是否出现在其他的模块或其他的地方?同一个故障是否有更加严重的问题?

对比Compare:如果测试人员以前曾经验证过现在出错的测试用例,那么他就应该检查以前的测试结果以检查相同的条件是否通过以前的测试。如果是的 话,那么这个问题就象是一个回归的错误。注意由于同一测试条件有可能出现在多个测试用例中,这个步骤就不仅仅只是检查一个测试用例在以前的多个结果。 总结Summarize:在bug report的第一行写上错误的总结是非常关键的。测试人员要花些时间思考已发现的错误对客户有何影响。这不仅仅要求测试人员编写的报告要能够吸引读者,使和管理层的沟通清晰,还要能够帮助设置错误修复的优先级别。

精简Condense:在bug report的初稿完成后,测试人员应该反复阅读它,集中剔除那些没有关系的步骤或词语。隐含的或模糊的说明和那些由于对没有任何关系的细节或者那些在重 现错误过程中不需要的步骤而消磨报告欢迎程度的无穷唠叨都不是bug report的目标。

消除歧义Disambiguate:测试人员在精简空话的同时或其之后随即应该再仔细检查报告是否有会产生误解的地方。测试人员应该尽量避免使用模糊的,会产生歧义的和主观的词语。目标是使用能够表述事实,清楚的,不会产生争执的词语。

中立Neutralize:如文中所述,作为坏消息的传递人,和善地提交消息是一个挑战。如同所有的错误总结一样,独立的bug report在措辞方面应该保持公正。攻击开发人员,指责潜在的错误,企图诙谐或使用挖苦将引起开发人员的憎恶,并且使注意力从“提高产品质量”这个大的 目标上转移开了。谨慎的测试人员只用Bug report来描述事实。

检查Review:一旦测试人员感觉bug report是他能够编写的最好版本,他应该将报告再给一个或多个同行进行检查。他的同事们也应该给出一些建议,为了澄清问题不断地提问,如果适当的话, 甚至可以挑战“错误成灾”的结论。在允许的时间里,测试小组应该尽可能提交最好的bug report。

以上10条技巧可以帮助你和你 的小组提交准确简洁的,彻底校订的,精心构思的,高质量的技术文档。测试小组应该集中编写bug report的任务,测试组长和经理应该让测试组成员清楚地认识到编写优秀的bug report是一项首要的工作任务。衡量优秀的bug report的质量指标应该包括如下:

对管理层来说,是清晰明了的,特别是在概要这一级;

对于开发部门是有用的,主要是给出能够让开发人员高效地调试问题的相关信息

可以很快的将bug从“Opened”状态转变成“Closed”状态,减少为得到更多的信息从开发人员打回的差的bug report并导致测试人员返工的时间。 改进bug报告的流程是需要花费一些时间的,但是也给予了效果显著的回报。首先,简单的流程改进了测试小组和高层、平行管理层之间的沟通,增强小组的信 任度,名望和鼓励管理层给测试投资更多的资源。第二,平稳地递交报告给开发人员促进了测试和开发人员之间积极的关系。第三,更短的bug生命周期是更加有 效的,在时间上之前花费在编写优秀bug report上的时间和后期由于返工差的bug report花费的时间相抵消。这些回报帮助开发流程通过有效的沟通和高效率的流程获得更好的产品质量。


第二篇:优秀的Bug报告


在Quality week上的一次演讲中,微软的一个测试经理,Roger Sherman指出了由于“不可重现”导致bug关闭的主要原因。这是一个非常可惜的情况,因为这样的bug report浪费了紧张的开发计划中的宝贵时间,增加了对产品质量完全是无关紧要的事情,同时导致了在开发人员和测试之间的挫败感和差的感觉。有时,bug report是由于短暂的或随机的事件,测试和开发之间不一致的工具和配置,或者在测试的环境下对正确的行为的模糊定义而产生的,但是许多的由于不可重现而被关闭的测试报告是因为描述不清晰,被误解,或者只是文字的错误。

下面领测国际教给大家一些能够引起管理层注意,更清楚的和开发人员沟通并得到修复的编写优秀bug report的诀窍。这些技巧不仅仅提供了是在被修复的问题的比例方面得到了可靠的回报,而且在同开发人员和管理层的通过中也得到了回报。在我管理的项目中使用这种方法编写bug report,8份bug report中大约只有一个没有被修复。

这篇文章的思想只有当你的报告针对的测试执行过程是专业的质量工作才可以发挥作用。聪明地执行完整的测试包是产生可靠的测试状况信息的基础的其中一个因素。在许多的测试文献中广泛地介绍了多种多样的关于如何构建这样的测试包的方法。选择和你质量风险管理需求相一致的技术并且使之适应你的具体情况,敏捷地监督已计划的测试的执行过程,这样你就可以拥有可靠的测试执行过程。

另外一个关键的因素-bug report,却没有得到太多的关注。这是非常令人遗憾的,因为优秀的bug report对反映测试小组真实的和可理解的工作质量同测试本身一样都是非常重要的。试想一下:如果你不能用开发人员能够理解的术语和能够用于调试的方法给开发人员解释一个错误,他怎么能够修复问题呢?如果你不能够在bug report中提出象“保险杆标签”(bumper sticker)一样的错误总结来引起管理层的注意,你又如何让他们关心你们发现的问题呢?

Bug report的核心是对错误的描述。表格1中是一个关于好和差的错误描述的例子。编写好的bug report是一种好的艺术形式。采用以下的10条技巧可以帮助你的小组提高编写bug report的质量:

. 组织Structure:测试人员应该采用深思熟虑的,小心谨慎的方法执行测试,并且

做详尽的记录。这样可以促使他们对测试下的系统有很好的认识。当错误发生的时候,一个有组织的测试人员能够知道最早出现问獾牡胤健? . 重现Reproduce:测试人员在编写bug report之前必须在检查问题是否可重现。

如果错误不可再重现,仍然应该写下来,但是必须说明问题的偶然性。一个好的处理原则就是在编写bug report之前反复尝试3次。 . 隔离Isolate:在尝试编写bug report之前,必须试着隔离错误。可以采用改变一

些变量的方法,如系统的配置,它可能可以改变错误的症状。这些信息可以为开发人员着手调试提供思路。

. 归纳Generalize:在测试人员发现了一个已隔离的,可重现的问题后,应该对问题

进行归纳。同一个问题是否出现在其他的模块或其他的地方?同一个故障是否有更加严重的问题?

优秀的Bug报告

. 对比Compare

优秀的Bug报告

:如果测试人员以前曾经验证过现在出错的测试用例,那么他就应该检查以前的测试结果以检查相同的条件是否通过以前的测试。如果是的话,那么这个问题. 总结Summarize:在bug report的第一行写上错误的总结是非常关键的。测试人

员要花些时间思考已发现的错误对客户有何影响。这不仅仅要求测试人员编写的报告要能够吸引读者,使和管理层的沟通清晰,还要能够帮助设置错误修复的优先级别。

. 精简Condense:在bug report的初稿完成后,测试人员应该反复阅读它,集中剔除那些没有关系的步骤或词语。隐含的或模糊的说明和那些由于对没有任何关系的细节或者那些在重现错误过程中不需要的步骤而消磨报告欢迎程度的无穷唠叨都不是bug report的目标。

. 消除歧义Disambiguate:测试人员在精简空话的同时或其之后随即应该再仔细检查报告是否有会产生误解的地方。测试人员应该尽量避免使用模糊的,会产生歧义的和主观的词语。目标是使用能够表述事实,清楚的,不会产生争执的词语。

. 中立Neutralize:如文中所述,作为坏消息的传递人,和善地提交消息是一个挑战。如同所有的错误总结一样,独立的bug report在措辞方面应该保持公正。攻击开发人员,指责潜在的错误,企图诙谐或使用挖苦将引起开发人员的憎恶,并且使注意力从“提高产品质量”这个大的目标上转移开了。谨慎的测试人员只用Bug report来描述事实。 . 检查Review:一旦测试人员感觉bug report是他能够编写的最好版本,他应该将报告再给一个或多个同行进行检查。他的同事们也应该给出一些建议,为了澄清问题不断地提问,如果适当的话,甚至可以挑战“错误成灾”的结论。在允许的时间里,测试小组应该尽可能提交最好的bug report。

以上10条技巧可以帮助你和你的小组提交准确简洁的,彻底校订的,精心构思的,高质量的技术文档。

更多相关推荐:
怎样写报告,报告格式和范文2篇

怎样写报告报告的范文一报告的定义报告是下级单位向上级单位或业务部门汇报工作反映情况和问题提出建议或意见答复上级单位询问事项的报请性公文将有关事项向上级报告目的是沟通上下级之间的关系传达信息使上级在决策和指挥工作...

报告的写作格式与范文

报告的写作格式与范文.txt如果我穷得还剩下一碗饭我也会让你先吃饱全天下最好的东西都应该归我所有,包括你!!先说喜欢我能死啊?别闹,听话。有本事你就照顾好自己,不然就老老实实地让我来照顾你!报告的写作格式报告适…

公文写作:报告写法及范文

建议报告关于××××××的报告院领导:根据×××××××××××××××××××××××××××××××××××××××××××××××××××××现将主要情况报告如下:一、××××××××××××××××××…

怎样写报告_报告格式和范文2篇

报告安徽润万家物业管理公司现申请将香水百合35物业值班室装修改造工程款冲抵物业费望予以批准附香水百合35物业值班室装修改造工程合同何明20xx年10月24日

报告的格式范文

报告的格式范文公文写作报告格式范文报告是向上级机关汇报工作反映情况提出意见或者建议答复上级机关的询问时使用的公文一报告的使用范围报告使用范围很广按照上级部署或工作计划每完成一项任务一般都要向上级写报告反映工作中...

函和报告的写作范文

由于函的种别较多,从制作式样到内容表述均有肯定灵敏机动性。主要引见榜样性公文的构造、内容和写法。公文由首部、正文和尾部三局部组成。其各局部的式样、内容和写法要求如下:(一)首部。主要包罗标题、主送组织两个项目内…

报告的写作格式

二报告的写作格式报告是向上级机关汇报工作反映情况提出意见或建议答复上级机关询问时用的陈述性公文一标题制发机关事由报告报告前可加紧急二正文事由直陈其事把情况及前因后果写清楚事项写工作步骤措施效果也可以写工作的意见...

如何撰写辞职信 辞职报告范文

辞职信模板中英文版辞职函xxxxx有限公司总经理室各位领导我带着复杂的心情写这封次致信由于您对我的能力的信任使我得以加入公司并且在短短的两年间获得了许多的机遇和挑战经过这两年在公司从事的xx开发和xx管理工作使...

如何撰写辞职信 辞职报告范文

辞职信模板中英文版辞职函xxxxx有限公司总经理室各位领导我带着复杂的心情写这封次致信由于您对我的能力的信任使我得以加入公司并且在短短的两年间获得了许多的机遇和挑战经过这两年在公司从事的xx开发和xx管理工作使...

旅游报告写作范文

专业定制各类报告淘宝华中秘书网报告名称云南大力发展旅游文化经云南省委九届八次全体扩大会议提出产业兴则经济兴加快产业转型升级提升产业发展水平已经迫在眉睫刻不容缓制约西盟佤族自治县发展的关键在产业西盟要与全国同步全...

调查报告写作格式及范文

调查报告写作格式一概念与特点调查报告是对某项工作某个事件某个问题经过深入细致的调查后将调查中收集到的材料加以系统整理分析研究以书面形式向组织和领导汇报调查情况的一种文书调查报告有以下几个特点一写实性调查报告是在...

述职报告格式及如何写述职报告

述职报告格式及如何写述职报告当前述职报告已成为经常写作的应用文写好个人述职报告应当明确以下几点1什么是述职报告述职报告就是把自己履行职责是否称职的情况写成书面文字所构成的文体具体一点是机关负责人就任职一定时期内...

写报告的范文(18篇)