提高书写水平是不断积累经验,循序渐进的过程。遵循一定的准则可以让编写软件缺陷报告变得容易。那么编写软件缺陷报告有哪些书写准则呢?在正式提交缺陷报告前,请对缺陷报告的内容和格式进行自我检查,可以避免很多不必要的错误。

遵循 5C 准则,如下图所示:

 

  • Correct(准确):每个组成部分的描述准确,不会引起误解和歧义,不夸大缺陷,也不要过于轻描淡写;
  • Clear(清晰):每个组成部分的描述清晰,不使用模棱两可的描述,比如出现“似乎(seem)”、“看上去可能(Possible)”等含义模糊的词汇;
  • Concise(简洁):只包含必不可少的信息,不包括任何多余的内容。这可以通过使用关键词,使摘要的描述短小简练,又能准确解释产生缺陷的现象。如“在新建任务窗口中,选择直接下达,负责人收不到即时消息”中“新建任务窗口”、“直接下达”、“及时消息”等就是关键词;
  • Complete(完整):包含复现该缺陷的完整步骤和其他本质信息,可以使开发人员很容易看懂缺陷;
  • Consistent(一致):按照一致的格式书写全部缺陷报告。

报告随机缺陷

随机缺陷是指缺陷偶尔出现或者在测试过程中只被发现过一次,但不知道如何使其再次出现。这样的缺陷可能是时间炸弹,如果产品交付客户时还出现这样的情况,会影响客户对产品的信心。而且如果技术人员需要很长时间评估客户的数据或环境,客户则会更加厌烦。

测试人员容易纠结这个问题:随机缺陷到底要不要上报?报吧,自己无法复现,无法和开发人员说明白;不报吧,万一被客户或者项目经理发现了,就比较麻烦了。所以对于随机缺陷应当采取适当的方法处理。

  • 首先,一定要及时详细的记录缺陷并提交到缺陷管理工具中,并在报告此类 Bug 时,明确说明自己不能复现这个程序错误,必要的时候要保存截图和相关日志,为开发解决 Bug 提供思维方向,并适当降低处理优先级。
  • 其次,在系统中留下随机缺陷的记录之后,考虑到测试项目的整体进度,对于一时难以再现的缺陷可以暂时搁置,稍后再寻找合适的时间去尽量复现,或者等开发人员有空的时候再一起调试。以免因为一颗大树而丢掉整个森林,保证项目的正常进度。
  • 最后,对随机缺陷要持续关注 3 到 5 个版本,如果在此期间从再未出现过,可以暂时关闭该缺陷,可能程序员在修改别的缺陷的时候无意中修复了这个缺陷;如果随机缺陷再次出现,可以让开发过来测试机前面现场分析。

该类问题出现的越少越好,虽然开发人员熟悉代码,也许可以很容易的从程序中获得解决软件缺陷的线索,但他们并不愿意也没有必要对发现的每一个软件缺陷都这么做。因为按道理讲,根本不存在随机缺陷这样的事,如果建立完全相同的输入和完全相同的环境条件,软件缺陷就一定会出现,无法复现也只能说明暂时还没有找到复现的步骤,因为建立完全相同的输入和完全相同的环境条件也不是一件容易的事情。

及时报告缺陷

发现一个缺陷要立即记录下来,不要在测试结束或每天结束之后,才开始一起提交,这样会遗忘一些 Bug,而且拖延的时间越长,关键细节被忘记的越多,程序错误被修改的可能性越小。

小缺陷也值得报告

被认为是很小的缺陷的情况可能包括拼写错误、小的屏幕格式问题、鼠标遗迹、小的计算错误、图形比例不准、在线帮助错误、不适当的灰掉了的菜单选项、不起作用的快捷键、不正确的错误信息,以及其他程序员认为不值得花精力去修改的缺陷。即使是一个很容易修改的小缺陷,也要及时提交到缺陷管理工具中,以免遗漏。小错误也可能会使客户感到困惑,并降低客户对产品其他部分的信心。

一个缺陷一个报告

不要试图把不同的程序错误合并到同一份报告中,来减轻项目经理或程序员对重复缺陷报告的不断抱怨。如果把多个缺陷写到同一份报告中,有些就可能不被注意得不到修改。虽然有时候几个缺陷可能最终查明是同一个原因,但是在修复之前是不知道的。单独报告即使有错,也比延误或者更糟糕地因为和其他缺陷混在一起而忘记修复要好。

以中性的语言描述缺陷

软件缺陷报告是针对产品,针对问题本身,将事实和现象客观地描述出来就可以了,否则开发人员和测试人员很容易形成对立关系。虽然发现很严重的缺陷是测试人员的“成绩报告单”,但却不可以喜滋滋的跑去“恭喜”那个倒霉的开发,或者使用类似“很糟糕”之类的带倾向性、个人观点和煽动性的措辞,不要对软件的质量优劣做任何主观性的批评和嘲讽。也不要使用一些带有情绪的强调符号,如黑体、全部字母大写、斜体、感叹号、问号等。

不要使用自认为比较幽默的语言,因为不同的读者其文化和观念不同,很多幽默内容在别人看来,往往难以理解,甚至可能引起误解。

少使用“我(I)”、“你(You)”等人称代词,可以直接使用动词或必要时使用“用户(User)”来代替。

引用别人的缺陷报告,不要擅自修改

引用别人的缺陷报告要小心,如果没有得到提交者的允许,可以补充评论,但不能编辑别人的材料。对于其他测试人员的缺陷报告即使很糟糕也不要擅自修改,如果需要在错误报告中做补充,要注明自己的姓名和日期。

以上技巧可以帮助测试人员提交准确简洁的,彻底校订的,精心构思的,高质量的缺陷报告。测试组长和经理应该让测试组成员清楚地认识到编写优秀的缺陷报告是一项首要且非常有意义的工作任务。

提高书写缺陷报告的水平是不断积累经验、循序渐进的过程。在正式提交缺陷报告之前,对缺陷报告的内容和格式进行自我检查,也可以避免很多不必要的错误,比如自我提问:

  • 缺陷报告已经向读者包含完整、准确、必要的信息了吗?
  • 一个缺陷报告中是否只报告了一种缺陷?
  • 读者是否能容易的搜索该缺陷?
  • 步骤是否可以完全复现而且表达清楚吗?
  • 是否包含了复现该缺陷需要的环境变量或测试所用的数据文件?
  • 缺陷的标题是按照原因与结果的方式书写的吗?
  • 实际结果和预期结果是否描述不够清楚而容易引起歧义吗?
posted on 2024-01-15 22:26  夜的第七章i  阅读(2)  评论(0编辑  收藏  举报