如何写出一份清晰的软件缺陷报告
姚看江湖 2022-09-28

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

声明: 本文转载自其它媒体或授权刊载,目的在于信息传递,并不代表本站赞同其观点和对其真实性负责,如有新闻稿件和图片作品的内容、版权以及其它问题的,请联系我们及时删除。(联系我们,邮箱:evan.li@aspencore.com )
0
评论
  • 相关技术文库
  • C语言
  • 编程
  • 软件开发
  • 程序
  • C语言的重要9个语句

      学习C语言最基础的知识点要数9条语句了,虽是基础内容,但用9条语句却可以实现很多功能。看了下面的每条语句的一一举例后,你就会觉得其实9条语句很简单,也不过如

    12-02
  • 浅谈单片机调试方法

    [导读]浅谈单片机调试方法

    11-30
  • STM32如何移植uCGUI,看这里!

    [导读]第一部分:在UCGUI移植之前在移植之前,首先要了解在网上下的UCGUI 3.98源码的文件结构是。UCGUI 3.98源码中有三个文件夹:1)“too

    11-22
  • 嵌入式汇编语言学习经验

    [导读]最近参与了一个项目,需要用嵌入式汇编写测试程序。汇编程序写过,C程序也写过,但是将它们混合起来写还是第一次,完全没有概念。只能上网找资料,自己慢慢摸索。

    11-22
  • 数字示波器在高频信号采集中的应用

    1 高频信号的采集 当要对一个高频信号(比如高达100MHz的雷达波形)进行采集和处理的时候。通常会设计一个高速或者超高速硬件采集电路,包括放大部分、滤波部分;A/D和D/A转换部分等,这种电路的要求非常高,要求边采集边存储,电路速度高,而且要考虑各种辐射干扰等,同时,目前市场上成品价格很难承受。并且根据采样定理,一个最高频率为/的连续信号,完全可以用时间上相隔了=1/2f的一系列离散采样值来表示...

    11-22
  • 单片机C语言static属性和数码管显示程序

    简介:static从英文上翻译是静态的意思,在C语言中static所起的作用也正是静态。对于局部变量而言,其作用域是局部的如某一子函数体,程序在每次执行时调用该

    11-21
  • LEMO产品进入EPLAN Data Portal绘图平台部件数据库

      EPLANDataPortal是一个基于web网络的平台,可以让工程师即时访问众多部件制造商的电气原理图,从现在开始,LEMO的连接器也加入了EPLANDa

    11-21
  • DAC0832三种波形的C语言程序

    波形发生器作为一种常用的应用电子仪器设备,传统的波形发生器可以完全用硬件电路搭建,如应用555 振荡电路可以产生正弦波,三三角波,方波等波形,传统的波形发生器多

    11-17
  • 虚拟仪器发展趋势及其对军用测试技术的影响

    1 引言从1986年NI公司提出VI概念到现在,经过十几年的发展,不仅VI技术本身的内涵不断丰富,外延不断扩展,在军事和民用领域均得到了广泛的应用,而且对现代测控技术产生了深远的影响。例如,VI原来最核心的思想是利用计算机的强大资源使本来需要硬件实现的技术软件化,以便最大限度地降低系统成本,增强系统功能与灵活性。由IT产业特征决定了VI技术也必须走标准化、开放性这条技术路线,目前VI已发展成具有G...

    11-16
  • 漫画:什么是 “跳表” ?

    —————  第二天  ————— 如何进行二分查找呢? 首先根据数组下标,定位到数组的中间元素: 由于要查找的元素20,大于中间元素12,再次定位到数组右半部分的中间元素: 这一次定位到的元素正好是20,查找成功。 如果数组的长度

    11-03
  • 总结4个Python数据读取的常见问题

    read_csv()是python数据分析包pandas里面使用频次较高的函数之一。它包括的参数差不多20个,可能一开始未必需要完整知道每个参数作用。不过,随着

    10-26
下载排行榜
更多
广告