当前位置:首 页 > IT客 > 查看文章

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

IT客 你是第1751个围观者 1条评论 供稿者: 标签:, , , ,

没错,任何软件都存在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。

猛击下载缺陷报告模板

这家伙很懒,什么都没写!

—— zhaorong

zhaorong
你可能也喜欢Related Posts
众说纷纭Comments
大眼 可爱 大笑 坏笑 害羞 发怒 折磨 快哭了 大哭 白眼 晕 流汗 困 腼腆 惊讶 憨笑 色 得意 骷髅 囧 睡觉 眨眼 亲亲 疑问 闭嘴 难过 淡定 抗议 鄙视 猪头
小提示:直接粘贴图片到输入框试试
努力发送中...
  1. 1 楼 NicolleVelma34

    Numerous effective folks experience framed pictures of this kind of a previous transactions check, trophies within a cabinet… it really is all half of reinforcing good character traits as well let them during the challenging occasions. The Profit Of Amount Sequences With e-Lottery – Far Out Sway Getting Tickets Singularly & A large amount If Not All Syndicates. Should you be craving for your very best winning lottery guidelines which will provide you with the chance to grow to be a millionaire, then examine this informative article. This will give you totally free lotto suggestions for winning. crazy
    crazy The lottery consists of white, yellow, red and blue marbles. Red is the top rated prize and in case you get this color, you win the set of 3 legendary beast shiny pokedolls. But, there exists only 1 red marble out of 400 colored marbles. So your odds of winning are one in 400. The blue marble is the second area and permits you to decide on one in the three Pokedolls. Not confident how many are inside the lottery, but I believe less than 5 out of 400. If I needed to guess I would say only 1 or 2. The 3rd prize may be the yellow marble and in the event you get this color, you win a set of shiny (distinctive color) legendary beast charms. I’m not sure the number of of those are inside the lottery, but I think lower than 10. Once more if I had to guess, I’d say 3-5 of them. The last area prize is definitely the white marble and it awards you a shiny legendary beast sticker. The colour marbles fluctuate from Pokemon Center to Pokemon Center, however the prizes are the identical. But I nevertheless will not discover why so different of them do it.

    2012年09月23日 09:14:41 回复 取消回复
  • 评论最多
  • 最新评论
  • 随机文章
footer logo
未经许可请勿自行使用、转载、修改、复制、发行、出售、发表或以其它方式利用本网站之内容
Copyright © zhaorong All Rights Reserved. 滇ICP备15006105号-1