Rules to Better Bug Management and Feedback
RuleSummaryIntro
Since 1990, SSW has supported the developer community by publishing all our best practices and rules for everyone to see.
If you still need help, visit SSW Consulting Services and book in a consultant.
Hold on a second! How would you like to view this content?
Just the title!
A brief blurb!
Gimme everything!
Page Content
When reporting bugs and giving product feedback, it is essential that you are as descriptive as possible, so that the developer can reproduce the error to find out what the problem is or understand what features you are requesting
Try to have one email per bug/suggestion, but if the bugs/suggestions are related or very small (e.g. they are all on the same page) then you should group them together in a single email.
-
- Figure: Bad Example - This email isn't going to help the developer much - it is vague and has no screen capture, and gives no alternate way for the developer to contact the user regarding the issue
-
- Figure: Good Example - This email includes the product name and version, the category of the issue (BUG), a screen capture and contact number, and shows that the user's system is up to date
Writing detailed emails like the above can be very time-consuming and laborious. Therefore, it is always a good idea to use a template to make sending quality bug reports quick and easy. A great example is the
Functional Bug template from the ASP.NET open source project.
Also, make sure your descriptions are detailed and useful as that can make finding the solution quicker and easier.
Make sure you always explain and give as many details as you can of how you got an error or a bad experience.
Where is TV.SSW on the navigation?
- Figure: Bad example - Lack of details
- Navigated to ssw.com.au
- Scrolling down looking for a big graphic like "CHECK OUT SSW TV! CLICK HERE!"
(Nothing)
Me, thinking… "Hmm… let's try the menu at the top..." - About Us? Nope.
- Services? Nope.
- Products and Support? Nope.
- Training? Nope.
- User Group? Nope.
- Rules? Nope.
Me, thinking... "OK. Now where? Most likely, the SSW company description will list it..." - Navigates to About Us.
- Me, scrolls down… nothing.
Me, thinking... "OK. Weird. Let's go back." - Me, goes back to homepage.
Me, thinking… "Is there a site map?" - Scrolls to bottom of page. Clicks sitemap link.
Me, thinking... "Ctrl+F for TV? Nope." - Me, gives up… types tv.ssw.com.au to try and get lucky. Huzzah!
- Figure: Good example - We can easily identify more the one way to improve the UX
Better than a good description of the bug is a screen recording. This should be followed for a more detailed report. Use Snagit (preferred) or Jing to record your screen.
- Figure: Good example - Recording bug reports in a video can make the issue clearer to see
- Figure: Good example - Giving feature requests via video
Related rules
.NET applications can sometimes produce a stack trace of an error, these error messages are all we need to figure out what has happened. Please do not send us this screen shot, instead, select the top section of what's within this box and paste it in an email that you can send back to us.
The text within the 'Details' button is more useful for debugging and locating the problem.
- Figure: Bug details window
See the end of this message for details on invoking
just-in-time (JIT) debugging instead of this dialog box.
We really want this part:
************** Exception Text **************
System.ArgumentException: invalid sender parameter
Parameter name: sender
at WindowsApplication3.FormStart.button5_Click(Object sender, EventArgs e) in c:\datajohnliu\datavs7projects\windowsapplication3\formstart.cs:line 143
at System.Windows.Forms.Control.OnClick(EventArgs e)
at System.Windows.Forms.Button.OnClick(EventArgs e)
at System.Windows.Forms.Button.OnMouseUp(MouseEventArgs mevent)
at System.Windows.Forms.Control.WmMouseUp(Message& m, MouseButtons button, Int32 clicks)
at System.Windows.Forms.Control.WndProc(Message& m)
at System.Windows.Forms.ButtonBase.WndProc(Message& m)
at System.Windows.Forms.Button.WndProc(Message& m)
at System.Windows.Forms.ControlNativeWindow.OnMessage(Message& m)
at System.Windows.Forms.ControlNativeWindow.WndProc(Message& m)
at System.Windows.Forms.NativeWindow.Callback(IntPtr hWnd, Int32 msg, IntPtr wparam, IntPtr lparam)
This part is quite useful sometimes too.
************** Loaded Assemblies **************
mscorlib
Assembly Version: 1.0.3300.0
Win32 Version: 1.0.3705.288
CodeBase: file:///c:/windows/microsoft.net/framework/ v1.0.3705/mscorlib.dll
----------------------------------------
WindowsApplication3
Assembly Version: 1.0.1129.31301
Win32 Version: 1.0.1129.31301
CodeBase: file:///C:/DataJohnLiu/DataVS7Projects/ WindowsApplication3/bin/Debug/WindowsApplication3.exe
----------------------------------------
System.Windows.Forms
Assembly Version: 1.0.3300.0
Win32 Version: 1.0.3705.288
CodeBase: file:///c:/windows/assembly/gac/system.windows.forms/ 1.0.3300.0__b77a5c561934e089/system.windows.forms.dll
----------------------------------------
System
Assembly Version: 1.0.3300.0
Win32 Version: 1.0.3705.288
CodeBase: file:///c:/windows/assembly/gac/system/ 1.0.3300.0__b77a5c561934e089/system.dll
----------------------------------------
System.Drawing
Assembly Version: 1.0.3300.0
Win32 Version: 1.0.3705.288
CodeBase: file:///c:/windows/assembly/gac/system.drawing/ 1.0.3300.0__b03f5f7f11d50a3a/system.drawing.dll
----------------------------------------
System.Xml
Assembly Version: 1.0.3300.0
Win32 Version: 1.0.3705.288
CodeBase: file:///c:/windows/assembly/gac/system.xml/ 1.0.3300.0__b77a5c561934e089/system.xml.dll
----------------------------------------
These are not really useful
************** JIT Debugging **************
To enable just in time (JIT) debugging, the config file for this
application or machine (machine.config) must have the
jitDebugging value set in the system.windows.forms section.
The application must also be compiled with debugging
enabled.
For example:
<configuration>
<system.windows.forms jitDebugging="true" />
</configuration>
When JIT debugging is enabled, any unhandled exception
will be sent to the JIT debugger registered on the machine
rather than being handled by this dialog.
How do you want customers to send you feedback? Phone calls? Emails? A website?
There are a number of web applications that do a great job on this:
-
UserVoice
-
GetSatisfication
-
UserEcho
Figure: The UserVoice website allows user to enter suggestions (used here by SSW Code Auditor)
Figure: UserVoice has an Administrator console to track feedback
UserVoice is the most popular platform to collect, manage, and prioritize user feedback. It has a voting and tickets system out of box.
Many software houses use this for their products eg. SSW Code Auditor, SSW Link Auditor
Here are the google results as at 2014
Figure: Google result of UserVoice
Figure: Google result of GetSatisfaction
Figure: Google result of UserEcho
Imagine this scenario... Mary notices a small error on a page in her intranet. She is a good employee... She fires up an email and reports the spelling error to info@s*w.com.au. As she sends it she says to herself "That it took more time to report the error than it would have taken me to fix it".
Small errors should be fixed by the person who found it. Text changes can be easily done in SharePoint or WordPress. If you know who is the culprit, it might be a good idea do inform that person, including the things you have fixed.
Your software is deployed. How do you tell users months or years later, important information?
This primarily affects Windows clients but even web clients shouldn't need a new version to give a new message.
Most software is deployed without any mechanism to insert a message in older software.
Messages might range from helpful tips that are undiscovered that would help a user do their job better?
Or helpful to remind old customers to get off their old version.
Eg. Sometimes customers are just not aware that their TFS or CRM installation is years old?
-
- Figure: Bad example
- Figure: Good example
