All software that is being developed WILL have bugs, sorry, but this IS a fact. Now I know some people and companies don't like to call them glitches in software bugs. They would rather call them issues or defects. For all I care we can call them 'WizBangs', just call them something and LOG THEM.
However, logging 'WizBangs' (ok, I will call them bugs from here on) is not as simple as it may sound. I would like to go over some of MY Do's and Don'ts in this post. If you don't like my list, or would like to add to it, drop me a line.
When to log Items:
- Do log everything. Just because the bug may seem trivial or simple or only happen 'every now and again' does not mean that it should be ignored. Even it you are not sure it is an issue, LOG IT. Better to have close off an non-issue then fail to report a major bug in hiding
- Don't assume that someone else is going to fix the issue. Also, don't assume this issue is too trivial or minor to report. Wouldn't it suck to find out after the application went lived that you failed to report a critical bug because you thought it was not a 'big deal'?
Providing information on the log:
- Do provide detailed information about the bug. Save yourself the headache later and provide as much information as you possible can. This should include, but not limited to items such as Build Version, Environment, Platform, Short Description of issue, Severity, Detailed steps to reproduce.
- Don't make provide a single sentence that says something like 'Unable to perform XYZ in the ABC process'. This type of information will provide nothing of real value to the next guy. Sure, this would be a great line for the title of the bug. But by no means is this enough information to fix the bug.
What types of items to log:
- Do Log Everything. Enough said
- Don't make assumptions
When to log bugs:
- Do log them as soon as possible.
- Don't put it off. If you dont log the bug as soon as you find it you WILL forget something about what you did to cause it. For the sake of your fellow co-workers log it now before you forget.
The plain and simple truth about logging bugs is, it sucks!!!! However, it is a necessary part of most developers jobs. If you take some time and put in a little effort, you will be rewarded with great riches. Ok, maybe not great riches, but it will make fixing the bugs much easier.
Till next time,
