Do you know how to report bugs and give suggestions?
If you are unclear use IM to ask, but remember the golden rule is to not send tasks on Teams.
It is recommended to keep track of active project backlogs on the company intranet, while also including the Product Owner and Tech Lead contact information, coupled with a link to the Teams channel of that project.
When reporting bugs and giving product feedback, it is essential that you are as descriptive as possible. This will save both you and the developer time and frustration in the long run.
Make sure you always explain and give as many details as you can of how you got an error or a bad experience. Detailed and useful descriptions can make finding the solution quicker and easier. The goal is to include enough details so the developer can focus on the development work more rather than trying to figure out what the feature requirements or bugs are.
See rules on Do you have a clear definition of a bug?
External source: How to produce a good bug report
Figure: Bad Example - This email isn't going to help the developer much - it is vague, has no screen capture or other details to help reproducing the error
|Subject:||🐛 BUG - PerformancePro - Error on startup|
I'm having a problem with your PerformancePro software. When I run it, this is what happens:
I have the latest version of all my software. I am running Windows 10 and Office365.
Can you please investigate and let me know how to proceed?
Figure: Good Example - This email includes the product name and version, the category of the issue (BUG), a screen capture, and informs the user's system
When possible, a great template to follow is the Functional Bug template from the ASP.NET open-source project. Spending time to provide as much detail as possible, by ensuring you have the 3 critical components:
- Steps to reproduce,
- Expected outcome, and
- Actual outcome
Figure: Bad example - Lack of details
|Subject:||SSW Website - Can't find SSW TV link|
I've searched the SSW website and can't find a link to SSW TV.
- Navigated to ssw.com.au
- Scrolling though home page. Nothing.
- Checked the menu at the top. Nothing.
- About Us? Nope.
- Services? Nope.
- Products and Support? Nope.
- Training? Nope.
- User Group? Nope.
- Me, thinking... "OK. Now where? Most likely, the SSW company description will list it..." Navigates to About Us... scrolling 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. Nope.
- Me, thinking... "Ctrl+F for TV? Nope."
When I navigate to ssw.com.au, I should see at the top of the page clear link to click on "CHECK OUT SSW TV!"
Couldn't find a link on the page.
- Can you help users to get to SSW TV website from SSW website
Figure: Good example - We can easily identify more the one way to improve the UX and there's a clear suggestion to action
Figure: Good example - Recording bug reports in a video can make the issue clearer to see
Define all the requirements as per Do your User Stories include Acceptance Criteria?
Figure: Good example - Giving suggestion requests via video
It depends on the team, but often the Product Owner is busy. If you know the Tech Lead and your suggestion is obviously a good one, then you should email the Tech Leader and Cc the Product Owner. The Product Owner can always reply if they don’t like the suggestion.
For a bug email:
To: Tech Lead
Cc: Product Owner
Subject: Bug - xxx
For a new feature email:
To: Tech Lead
Cc: Product Owner
Subject: Suggestion - xxx
Always go for backlog if you have access to a backlog management system otherwise email relevant people. You may have a group email such as firstname.lastname@example.org, You would only Cc this email when a greater visibility is required.
Create an Issue/PBI and @mention relevant people (GitHub and Azure DevOps will generate a nicely formatted email)
See rules on Do you know when you use @ mentions in a PBI?
If they are all related to one area, then you could consider put them together, otherwise don’t bunch them up.
See rules on Do you send tasks one email at a time?
When you create a bug/suggestion to a backlog, it's a good idea to add emoji in the title. Not only does it look nicer, but people can look at the item and take in the necessary information quickly.
This means that anyone looking at the backlog can glean its nature at a glance, rather than having to read each item to know what category it is (5 bugs, 2 features, etc). Examples:
- 🐛 Bug - Calendar is not showing on iOS devices
- ✨ Feature - Add 'Back to menu' item to top navigation
Check out the rule on Do you know which emojis to use in Scrum?
Tip: GitHub Issue Templates can help you with that.