Scribd
Upload
14 views

DAQA Bug Writing Guide

The DAQA Bug Writing Guide provides detailed instructions for writing effective bug reports to aid developers in reproducing and fixing issues. It emphasizes the importance of clarity, thoroughness, and proper documentation, including steps to reproduce, expected results, and severity classification. The guide also includes examples of good and bad bug writeups to illustrate best practices.

Uploaded by

ininaklot
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
14 views

DAQA Bug Writing Guide

The DAQA Bug Writing Guide provides detailed instructions for writing effective bug reports to aid developers in reproducing and fixing issues. It emphasizes the importance of clarity, thoroughness, and proper documentation, including steps to reproduce, expected results, and severity classification. The guide also includes examples of good and bad bug writeups to illustrate best practices.

Uploaded by

ininaklot
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

DAQA Bug Writing Guide

Version 1.2 (12/9/2024)


It is essential to be highly descriptive with bug writing, so developers can reproduce and fix each one.
Try to remember what happened leading up to the encountered bug and illustrate the main steps to
encounter the bug The bug report needs to be easy to follow so that the developer can replicate the bug
and fix it.
Important Note: While attempting to reproduce a defect is an important step before writing your bug, if
you're unable to reproduce it, the Steps to Reproduce need to be what you remember happened
leading up to the bug. Do NOT just put "unable to reproduce" here.
Remember to include the who, what, when, where, and how in each of your bugs. Additionally, include
the number of times the bug was able to be reproduced out of 5. The more descriptive you are the
better the chances of getting a fix from the production staff, and that’s the real aim of reporting bugs.

Important Instructions
• Check for dupes before writing a bug. If the bug has already been documented, don’t write up a
new one. If you have new info for the existing bug (ie. Found out how to reproduce it another
way), append the information to the existing bug.
o Note: This may not be applicable to every test, such as larger ones, so if we do not
provide a way to check duplicates or explicitly say to not report a specific bug, go ahead
and report it.
• Take your time writing bugs, make sure they are simple and clear.
• Summaries should be brief: 1 sentence ideally. Use the repro steps to fill in the details.
• Attempt to reproduce the issue, at least 4-5 times (unless it very obviously has a 100% repro
rate) and note the outcome in the bug writeup.
• Make sure proper item/asset names are included in bug writeups. (Bad: “Grab the blue sword
and hit an enemy with it”. Good: “Pick up the Sword of Fargoal and strike a Master Orc with it”).
• Use the terminology list provided by the game studio if available.
• Always try to add screenshots or videos where applicable.
• Check severities carefully. Crashes and freezes, for example, are always Critical.
• Try to eliminate any unnecessary steps when researching a bug. While some bugs might require
10 or more steps to reproduce it, there are usually some extraneous steps that could be
eliminated from the sequence of steps.
• Bugs should be functional and NOT include quality feedback. Reserve game feedback for test
surveys unless specifically requested.
• Do your best to remember to write bugs from a 3rd person POV. (ex: "The player/tester
encountered a freeze when….). Try to avoid using the word "I" when describing a bug.
Severities:
Critical: This is a bug that completely stops or greatly hinders to the point of failure the testing efforts
for the game or feature set being tested.*Note* All crashes and freezes are critical.
Major: This is a bug that is highly visible and severe, although it does not collapse the entire game or
feature set, it does greatly impact its functionality.

Minor: This is a bug that affects the game however it does not restrict its function in any way. These
bugs are undesirable but do not stop the functioning of the game.

Bug Writing Elements:


1. Summary line (short, sweet, summation of the problem–ideally 1 sentence).
2. Steps to Replicate using numericals (The steps needed in chronological order to reproduce the
issue).
3. The Expected Result (what should have happened instead of the problem).
4. The correct severity (Critical, Major, Minor–See above).

Bad Bug Writeup


Expected
Summary Steps to reproduce
Behavior
Found an alpaca, befriended, named and Found my first alpaca and befriended them. Was expecting to
made my current mount. Couldn't mount so I Named them Dragonking. Made the alpaca have an alpaca
figured the game just got confused, so got my current friend/mount and then started friend and
another mount and my alpaca back. At this to work on raising its friendship level. Fed continue to the
point I had to name them again, when I did them some grapes and brushed to get to new zone.
the game crashed. level one. Tried to mount to ride to the
briars and I could not. Another heart
appeared over the alpaca's head and had to
name them again. Picked the same name
and crashed.
Good Bug Writeup
Summary Steps to reproduce Expected
Behavior
Game crashes when attempting to mount 1. Find an alpaca and befriend it. Player should be
alpaca after renaming it. 2. Name the Alpaca. able to mount and
3. Make the alpaca your current rename alpaca
mount. without
4. Feed it some grapes and brush it to experiencing a
get to increase friendship level. crash.
5. Attempt to mount the alpaca. Note
another heart appears over the
alpaca's head and you have to name
them again.
6. Picked the same name and note that
the game crashes.
Was able to reproduce 5/5 times.

You might also like