你知道怎样写一份良好的缺陷(Bug)报告吗?

  是的,任何一款软件中都会存在bug,甚至就连是我们自己也存在着缺陷,因为程序员也不过是普通人,而只要是人就会犯错误的。当有人在使用软件的时候遇到软件bug,你需要的使用你的邮件形成一份缺陷bug,然后发送给开发人员。而开发者可以依据这份报告来定位问题,复现问题,从而修复问题。

  但是在很多时候,开发人员反而很难理解用户提交上的缺陷报告,那是因为发送人并不了解我们需要的是什么,那应该怎样和开发人员沟通,还有应该如何写出一份缺陷报告,在我写的这篇文章中,我将会来教你怎样去写一份清晰的缺陷报告才能够让开发者理解、复现并修复问题。

  为什么要发送缺陷报告

  缺陷报告可以用很多方式来帮助我们的开发者。

  ● 他们能告知我们没有意识到的问题

  ● 他们能发现我们可能还没想到的新特性

  ● 他们能帮助我们感受到客户是如何使用我们的软件,以至于我们可以做的更好

  没有这些缺陷报告,我们就不知道出错的地方,我们需要它就像你唱歌跳舞时需要有软件的支持一样。

  什么时候发送缺陷报告

  ● 简单来说就是越快越好,详细来说就是:

  ● 当你看到一个错误消息时就发送错误报告

  ● 当屏幕是空白或者数据缺失就发送报告

  ● 当程序没有出现预期的结果时发送报告

  ● 当程序崩溃、死机、没有响应或者响应很慢时发送报告

  ● 当程序返回错误结果时发送报告

  ● 当你得不到想需要的结果时发送报告

  ● 如果你不清楚怎样做时发送报告

  ● 如果你不喜欢软件做的方式,或者软件老打搅你时,发送错报告

  ● 如果你想在系统中实现一个变通方案时发送报告

  缺陷报告需要有哪些内容

  缺陷报告应该包含很多信息,你提供的信息越多效果越好,对于开发者,就像我,提供一个纯文本文件模板给你填充然后邮件发给我,当然也有表格形式的,但是最期待你自己杜撰一份然后发给我。下面是一些必须包括的部分以及如何写好每部分:

  标题:创建一个简短的标题,让问题看起来更清晰。“应用崩溃”是一个很恼人的标题因为它没有足够的信息包括在这份报告里面。取而代之的是标题应该包含错误消息和消息码,或者是结果的名称以及失败时你正在做的事情。例如:Error 402:访问拒绝当点击“发送邮件”这个例子就提供了缺陷系统的上下文信息。

  差:“程序崩溃”,“报错”,“Bug”

  好:“从’Kifu’中打印时5C79错误”,“’Kifu honors’报表为空”

  产品:用名称标识产品,告知你使用的是哪个版本。绝大部分软件都包含有版本信息。web应用的版本信息通常在页脚。

  差:“你的应用”

  好:”Kifu v1.01″

  平台:告诉我们软件运行在什么平台。尤其是操作系统的名字及版本和游览器名称版本。特别是web应用,这些信息对我们很重要。

  差:“Windows”

  好:“Windows7,IE9”

  是否能重现:有些恼火的Bug是间歇性的出现,我们想预先知道,如果我们正在处理一个灵异事件或者正逢Bug出现时。

  差:留空白

  好:“每次”,“偶然”,“不重现”

  描述:这部分是很多人拿不定的地方,不知道怎么描述问题,在描述中做到包括下面的内容:

  ● 总结:用简洁的语言概括出Bug出现时你正在做的事情。从上下文开始,在操作应用的哪个部分。聚焦在你做的时候软件做了什么?

  差:“系统不能用了”

  好:在“honor report”页面单击“打印按钮”,但是报表是空的。

  ● 发生了什么:一步一步描述你做的事情当bug出现时,为什么你认为是错误的。事无巨细,打印出菜单的名称,页面标题,点击时的按钮或者链接的名称。做相同的操作是不是出现一样的错误。

  差:“空白报表”

  好:“点击 ‘File/Save as…’,’Save‘对话空弹出,然后点击‘OK’按钮,但是文件没有保存”

  ● 错误时什么:如果错误消息出现时,拷贝粘贴整个信息,这样更有利于我们跟踪错误。

  差:“有个错误,点击它始终读不出”

  好:“Error 403:访问拒绝”

  ● 复现的步骤:如果你可以让bug重现,那太好了,这能提供很大的帮助。一步步描述如何重现次bug。

  差:“打印没法使用”

  好:“从‘Honors Report’页面,点击‘打印按钮’”

  ● 预期结果:描述你预期发生的结果当bug发生时,这部分特别有用如果程序没有按照你期待的结果发生时,因为它很诡异。

  差:“我期待能正常工作”

  好:“我期待能看到‘Honors Reports’的PDF文件”

  真实结果:当bug发生时是怎么发生的,什么错误,为什么有错,或者如果错误抛出,抛出什么错。

  差:“没法用”

  好:“我收到是空的PDF文件,或者’403错误,访问拒绝’”

  ● 附件:如果你知道怎么截屏,做吧,附上一个简短的错误,截屏可以是错误之前或者发生错误之后,我们的开发者能够看到究竟发生了什么。如果应用有崩溃的日志,同样附上它。

  ● 联系方式:附上你的名字和email,我们可以让你提交的报告及时的得到答复,在我们不理解问题的描述时还能够询问你,如果你忘记附联系方式了,我们也就没法联系到你,也没法修复bug。

时间: 2024-08-25 11:53:56

你知道怎样写一份良好的缺陷(Bug)报告吗?的相关文章

如何写一份良好的缺陷(Bug)报告

没错,任何软件都存在bug,哪怕是我们自己也存在缺陷,因为程序员也是普通人,人是会犯错误的.当有人在使用软件时遇到bug,你需要使用邮件形成一份缺陷bug,发送给开发人员.开发者可以依据该报告定位问题,复现问题,修复问题. 但是很多时候,开发人员很难理解提交上的缺陷报告,因为发送人并不了解我们需要的是什么,那如何与开发人员沟通以及如何写出一份缺陷报告,在这篇文章,我将教你如何写出一份清晰的缺陷报告能使开发者理解.复现.修复问题,这里下载缺陷报告模板. 为什么要发送缺陷报告 缺陷报告可以用很多方式

控件-跪求C++大神帮小弟写一份简单的程序

问题描述 跪求C++大神帮小弟写一份简单的程序 大作业具体要求:文档应用程序,要包含文件的读写,包含弹出对话框,对话框上有非静态控件,视图或对话框上要有个人信息的显示.题目自拟,要包含上述要素!求神助谢谢了,邮箱442987113@qq.com 解决方案 直接拿写字板mfc程序修改下,在about框加上个人信息就可以了. http://download.csdn.net/download/playboy1/3697524 http://download.csdn.net/download/sst

求一通讯录,只要求有基本的功能,如查找,添加等,有好手的话,给写一份,急用,从网上找的勿打扰,非诚勿扰

问题描述 求一通讯录,只要求有基本的功能,如查找,添加等,有好手的话,给写一份,急用,从网上找的勿打扰,非诚勿扰 解决方案 解决方案二:再加点补充.不要数据库啊,呵呵解决方案三:有人会给你写的话,我跟你姓.解决方案四:引用2楼laowai250的回复: 有人会给你写的话,我跟你姓. 别人如果做过的话,可能会给你一份,别人也要工作,哪有时间给你写啊.解决方案五:小伙子,如果是毕业设计就自己动手,爱莫能助如果是公司要,直接让他用excel,这功能还用整个软件,有病啊解决方案六:JavaSwing开发

一份靠谱的数据分析报告都有什么套路?

在这个人人都是数据分析师的时代,写好一份数据分析报告的重要性不言而喻.但一份靠谱的数据分析报告都有那些套路呢? 1.清晰的分析目标 这是结果导向的数据分析工作的出发点.只有明确分析目标,才能有一个良好的驱动过程.无论是目标驱动还是分析过程驱动,你后续的数据分析工作和分析报告里所要呈现的全部内容事项都是紧紧围绕着这个目标主题而服务的.在开始数据分析之前明白要做什么很重要,如果你是主动要做一份数据分析报告,目的自然很清楚;但这样的主动性,在职场里并不多见,那么当你的上司请你制作一份数据分析报告的时候

如何做一份有效的线上活动执行报告

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 在上一篇博文"线上活动策划方案的基本思路及框架"中,同大家一同分享了一个"可执行"的线上活动策划案是如何炼成的.一个好的线上活动3分靠创意,7分靠执行.作为一名线上活动策划师,千万别以为案子一通过就万事大吉了,这仅仅只是一个开始.有太多的问题等着你去发现,有太多的事情等着你去协调,从网站策划师策划出活动

一份来自Heavy Reading的报告显示

一份来自Heavy Reading的报告显示,随着移动运营商们部署LTE网络,他们将需要更新其网络安全战略,因为来自公共互联网和新应用程序的攻击造成的威胁正日益增加. 根据<3G和4G网络的下一代移动安全网关>报告显示,新一代的移动宽带网络更容易受到攻击,并且面临着更宽泛的各种各样的安全威胁,超过之前的以语音为中心的时代. 这是因为,大多数运营商都将在未来几年推出LTE服务,这是一张完全不同的网络架构,且其本身可能将引入新的漏洞,由于4G网络拥有一个平面,IP架构相较前几代移动网络可能更容易成

互联网行业首份插件售价站长调查报告

中介交易 http://www.aliyun.com/zixun/aggregation/6858.html">SEO诊断 淘宝客 云主机 技术大厅 在中国互联网行业中,站长是个庞大的群体.据不完全统计,全国站长人数已超过300万.君不见,各地区各种类型的站长大会此起彼伏.而这些站长们的网站大部分都是使用各种开源系统搭建起来的,为此业内也出现了一批著名的CMS.BBS.SNS.WIKI.BLOG等开源建站系统. 插件,作为一个网站区别于同类网站的重要功能的体现,也就应运而生了.目前市面上出

法国公布首份法航客机失事调查报告

这是6月12日在巴西东北部城市累西腓空军基地拍摄的法航客机残骸.新华社/路透 6月12日,在巴西东北部城市累西腓的空军基地,记者拍摄失事的法航客机残骸.新华社/法新 新华网巴黎7月2日电 法国民航安全调查分析局2日召开新闻发布会,公布首份法航客机失事调查报告.调查人员目前已经排除失事客机在空中解体的假设,而飞机"黑匣子"的搜寻工作将一直持续到7月10日才会结束. 法国民航安全调查分析局事故调查负责人阿兰·布亚尔在介绍调查情况时说,客机失事之后,搜寻人员共找到了640余片来自失事客机各个

如何写一份交互说明文档

离开交互圈已经有段时间了.但由于博客还在,还是能够偶尔收到一些邮件,上周有位同学问我:我在求职,我看到很多招聘说明上需要交互设计师编写界面交互设计文档,请问界面交互设计文档是什么文档?怎么编写呢 这让我想起来2009年自己在项目里也大力推行过交互说明文档(在下文中,简称为DRD),格式倒没什么限制,交互设计师自己写到界面上也行,单独文档成文也行,总之就是让交互设计师能够将界面承载不了的信息通过文档沉淀下来,降低项目里的沟通成本和风险.今天整理电脑,翻出以前的PPT,分享之. 这将涉及到几个问题: