Casbin = way to authorization
A place for Casbin developers and users
Sign Up Now
For Existing Member  Sign In
Choose theme
Default ✅
v2ex-zhihu-theme 
yushu001
Casnode  ›  灌水

如何编写好的错误报告?技巧和窍门

  •  
  •  
    yushu001 · 4 years ago · 152 hits 
    This is a topic created 1520 days ago, the information in it may have changed.

    好的软件错误报告的质量是什么? 任何人都可以编写错误报告。但是并不是每个人都可以编写有效的错误报告。

    您应该能够区分平均错误报告和良好错误报告。如何区分错误报告的好坏?非常简单,应用以下特征和技术来报告错误。

    特点和技术包括

    #1)明确指定错误编号: 始终为每个错误报告分配唯一的编号。反过来,这将帮助您识别错误记录。如果您使用任何自动错误报告工具,那么每次报告错误时,都会自动生成此唯一编号。

    请注意报告的每个错误的编号和简短描述。

    #2)可复制: 如果您的错误不可复制,那么它将永远无法修复。

    您应该明确提到重现该错误的步骤。不要承担或跳过任何复制步骤。逐步描述的错误易于复制和修复。

    #3)具体: 请勿撰写有关该问题的文章。

    要具体点。尝试以最少的语言总结问题,但要有效。即使它们看起来很相似,也不要合并多个问题。针对每个问题编写不同的报告。

    有效的错误报告 错误报告是软件测试的重要方面。有效的错误报告可与开发团队保持良好的沟通,并避免造成混乱或沟通不畅。

    一个好的 Bug 报告应该清晰简洁,并且没有遗漏关键点。缺乏清晰度会导致误解,并且也会减慢开发过程。缺陷编写和报告是测试生命周期中最重要但被忽略的领域之一。

    良好的写作对于提交错误非常重要。测试人员应牢记的最重要一点是不要在报告中使用命令性语气。这破坏了士气并造成了不健康的工作关系。使用提示音。

    不要以为开发人员做错了,因此您可以使用苛刻的话。在报告之前,检查是否已报告同一错误同样重要。

    重复的错误是测试周期的负担。检查已知错误的整个列表。有时,开发人员可能已经知道此问题,因此在以后的版本中将其忽略。也可以使用诸如 Bugzilla 之类的工具来自动搜索重复的错误。但是,最好手动搜索任何重复的错误。

    错误报告必须传达的导入信息是 “如何?” 和 “哪里?” 该报告应明确回答测试的执行方式以及缺陷的确切位置。读者应该轻松地重现该错误并找到错误所在。

    请记住,编写 Bug 报告的目的是使开发人员能够直观地看到问题。他 / 她应该从 Bug 报告中清楚地了解缺陷。请记住提供开发人员正在寻找的所有相关信息。

    另外,请记住,将保留一个错误报告以供将来使用,并应将其与所需信息一起正确编写。使用有意义的句子和简单的单词来描述您的错误。不要使用会浪费审阅者时间的混淆性陈述。

    将每个错误报告为一个单独的问题。如果单个错误报告中有多个问题,除非所有问题都解决了,否则您将无法关闭它。

    因此,最好将这些问题分解为单独的错误。这样可以确保可以分别处理每个错误。编写良好的错误报告可帮助开发人员在其终端上重现该错误。这也有助于他们诊断问题。

    如何报告错误? 使用以下简单的错误报告模板:

    这是一种简单的错误报告格式。它可能会因所使用的错误报告工具而异。如果您是手动编写错误报告,则需要特别提及一些字段,例如错误号,应手动分配。

    记者: 您的姓名和电子邮件地址。

    产品:您在哪个产品中发现了此错误。 TrueOS 最初由 FreeBSD 专家 Kris Moore 于 2005 年初创立,当时被命名为 PC-BSD。2006 年 8 月,它被 OSWeekly.com 评选为最适合初学者的操作系统。2016 年,PC-BSD 更名为 TrueOS 。

    152 hits  ∙  0 favorites  
      Tweet Weibo Ignore 
    No reply yet
    About   ·   FAQ   ·   API   ·   Mission   ·   Advertise   ·   Thanks   ·   Tools   ·   20 Online   Highest 40   ·     Select Language  ·     Select Editor
    Community of Creators
    World is powered by code
    VERSION: 2c477f2 · 36ms · UTC 16:41 · PVG 00:41 · LAX 09:41 · JFK 12:41
    ♥ Do have faith in what you're doing.