Do you know how to report bugs and give suggestions?
Updated by Tiago Araújo [SSW] 2 months ago. See history
123
When reporting bugs or providing product feedback, it’s important to include as much relevant detail as possible. Make sure it reaches the right people through the right channel - ideally the product backlog, or email if needed. A well-written report saves time and avoids frustration for both you and the developers.
## ✅ Use YakShaver
The best way to report bugs or share feedback is by using [YakShaver](https://yakshaver.ai/).
YakShaver is a smart tool that simplifies how you report issues and give feedback. Instead of spending time writing a detailed report or figuring out who to send it to, you just record a quick video and YakShaver handles the rest.
Using AI, YakShaver analyzes what you've said and automatically routes the issue to the right person. This means you don’t have to worry about choosing the right backlog, tagging the right team member, or following up to make sure it landed in the right place. It speeds up communication, reduces misunderstandings, and allows everyone to focus on solving the real issue instead of getting bogged down by process.
<youtubeEmbed url="https://www.youtube.com/shorts/0TPo98R1tnI" description="Video: What is YakShaver? | Ulysses Maclaren (1 min)" />
---
## ❌ Do it manually
If you can’t use YakShaver for some reason, follow these 8 tips to do it right manually:
* [Tip #1: Draft your bug with enough details](#tip-1-draft-your-bug-with-enough-details)
* [Tip #2: Draft your suggestion with the complaint and what you expect to see](#tip-2-draft-your-suggestion-with-the-complaint-and-what-you-expect-to-see)
* [Tip #3: Should you send this to the Product Owner or the Tech Lead?](#tip-3-should-you-send-this-to-the-product-owner-or-the-tech-lead)
* [Tip #4: Should you email or put it in the backlog?](#tip-4-should-you-email-or-put-it-in-the-backlog)
* [Tip #5: Do you make it easy to find all the backlog in your company?](#tip-5-do-you-make-it-easy-to-find-all-the-backlog-in-your-company)
* [Tip #6: Make sure when using backlog, the Product Owner will still get an email](#tip-6-make-sure-when-using-backlog-the-product-owner-will-still-get-an-email)
* [Tip #7: Separate PBIs](#tip-7-separate-pbis)
* [Tip #8: Use emojis and prefixes for PBI/Issues titles, or email subjects](#tip-8-use-emojis-and-prefixes-for-pbiissues-titles-or-email-subjects)
<imageEmbed
alt="Image"
size="large"
showBorder={false}
figureEmbed={{
preset: "default",
figure: 'Making the Product Backlog the main source of tasks',
shouldDisplay: true
}}
src="/uploads/rules/report-bugs-and-suggestions/report-bugs-and-suggestions.png"
/>
### Tip #1: Draft your bug with enough details
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.
Things to include:
* Steps to reproduce the error
* OS and browser details
* Screenshots\
**💡 Tip:** Copy and paste the text for searchability
* Video for more complex bugs (more info below)
Learn more:
* [Do you have a clear definition of a bug?](/definition-of-a-bug)
* [How to produce a good bug report?](https://www.boxuk.com/insight/what-makes-a-good-bug-report)
<emailEmbed
from=""
to="{{ SUPPORT EMAIL }}"
cc=""
bcc=""
subject="Your software"
body={<>
## Hi
I'm having a problem with your software. When I run it, it says something about registration and then exists.
Can you tell how to fix this?
Thanks
</>}
figureEmbed={{
preset: "badExample",
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",
shouldDisplay: true
}}
/>
<emailEmbed
from=""
to="{{ SUPPORT EMAIL }}"
cc=""
bcc=""
subject="🐛 BUG - PerformancePro - Error on startup"
body={<>
## Hi team
I'm having a problem with your PerformancePro software. When I run it, this is what happens:
1. Run the application from Start | Programs
2. Access opens
3. I get this error:
Here is the transcription for searchability:
> An embedded page at chrome-extension://laookkfknpbbblfpciffpaejjkokdgca says:
> Could not find resource: longtail performance counter.
> Prevent this page from creating additional dialogs.
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?
Thanks
</>}
figureEmbed={{
preset: "goodExample",
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",
shouldDisplay: true
}}
/>
#### Functional Bug template
When possible, a great template to follow is the [Functional Bug template](https://github.com/aspnet/Home/wiki/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
* Actual outcome
<emailEmbed
from=""
to="Danny"
cc=""
bcc=""
subject="SSW TV"
body={<>
## Hi Danny
Where is SSW TV on the navigation?
Adam
</>}
figureEmbed={{
preset: "badExample",
figure: "Bad example - Lack of details",
shouldDisplay: true
}}
/>
<emailEmbed
from=""
to="Danny"
cc=""
bcc=""
subject="SSW Website - Can't find SSW TV link"
body={<>
## Hi Danny
I've searched the SSW website and can't find a link to SSW TV.
1. Navigated to ssw.com.au
2. Scrolling though home page. Nothing.
3. Checked the menu at the top. Nothing.
4. About Us? Nope.
5. Services? Nope.
6. Products and Support? Nope.
7. Training? Nope.
8. User Group? Nope.
9. Me, thinking... "OK. Now where? Most likely, the SSW company description will list it..." Navigates to About Us... scrolling down... Nothing.
10. Me, thinking... "OK. Weird. Let's go back." Me, goes back to homepage.
11. Me, thinking... "Is there a site map?" Scrolls to bottom of page. Clicks sitemap link. Nope.
12. Me, thinking... "Ctrl+F for TV? Nope."
### Expected result
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!"
### Actual result
Couldn't find a link on the page.
1. Can you help users to get to SSW TV website from SSW website
Adam
</>}
figureEmbed={{
preset: "goodExample",
figure: "Good example - We can easily identify more the one way to improve the UX and there's a clear suggestion to action",
shouldDisplay: true
}}
/>
#### Make it extra clear with videos
Better than a good textual description of a bug report is a screen recording. This should be followed for a more detailed report. Use [Snagit](http://www.techsmith.com/snagit.html) or [Camtasia](/production-do-you-know-how-to-start-recording-with-camtasia) to record your screen.
<youtubeEmbed url="https://www.youtube.com/embed/y9vsGY1hYN0" description="" />
<figureEmbed figureEmbed={{
preset: "goodExample",
figure: 'Video: Good example - Recording bug reports in a video can make the issue clearer to see (1 min)',
shouldDisplay: true
} } />
Recording a stepped user flow of actions that walk through through an issue is another excellent way of reporting a problem that is easily understood and reproducible. There are many tools you can use to make recording these steps easy, for example [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47) which is built in to Windows, or [Microsoft's Test & Feedback extension](https://learn.microsoft.com/en-us/azure/devops/test/perform-exploratory-tests?view=azure-devops#install-the-extension) for Chrome, Edge and Firefox.
See our rules for setting up and using these tools at [Do you use Problem Steps Recorder?](/do-you-use-problem-steps-recorder/) and [Do you do exploratory testing?](/do-you-do-exploratory-testing/)
<imageEmbed
alt="Image"
size="large"
showBorder={false}
figureEmbed={{
preset: "goodExample",
figure: 'Good example - Using a tool to record steps replicating an issue is a great and simple way to report a problem that\'s easy for a developer to understand and reproduce',
shouldDisplay: true
}}
src="/uploads/rules/report-bugs-and-suggestions/psr3.png"
/>
### Tip #2: Draft your suggestion with the complaint and what you expect to see
Define all the requirements as per [Do your User Stories include Acceptance Criteria?](/acceptance-criteria)
Better than a good textual description of a suggestion request is a screen recording. This should be followed for a more detailed report. Use [Snagit](http://www.techsmith.com/snagit.html) or [Camtasia](/production-do-you-know-how-to-start-recording-with-camtasia) to record your screen.
<youtubeEmbed url="https://www.youtube.com/embed/VDZSfHJ7GNU" description="" />
<figureEmbed figureEmbed={{
preset: "goodExample",
figure: 'Video: Good example - Giving suggestion requests via video (5 min)',
shouldDisplay: true
} } />
### Tip #3: Should you send this to the Product Owner or the Tech Lead?
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.
If you are unclear use IM to ask, but remember [the golden rule to not send tasks on Teams](/important-chats-should-be-in-an-email).
<asideEmbed
variant="greybox"
body={<>
**For a bug email:**\
  **To:** Tech Lead\
  **Cc:** Product Owner\
  **Subject:** Bug - {{ SUMMARY OF BUG }}
**For a new feature email:**\
  **To:** Tech Lead\
  **Cc:** Product Owner\
  **Subject:** Suggestion - {{ SUMMARY OF SUGGESTION }}
</>}
figureEmbed={{
preset: "default",
figure: 'XXX',
shouldDisplay: false
}}
/>
### Tip #4: Should you email or put it in the backlog?
Always go for backlog if you have access to a backlog management system, otherwise email relevant people.
<asideEmbed
variant="info"
body={<>
You would only Cc group emails - such as `all@northwind.com.au` - when a **greater visibility** is required.
</>}
figureEmbed={{
preset: "default",
figure: 'XXX',
shouldDisplay: false
}}
/>
### Tip #5: Make it easy to find backlogs within your company
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.
<imageEmbed
alt="Image"
size="large"
showBorder={false}
figureEmbed={{
preset: "default",
figure: 'An intranet page with links to projects’ backlog to make it easy for everyone to find. Note some projects have more than 1 backlog.',
shouldDisplay: true
}}
src="/uploads/rules/report-bugs-and-suggestions/do-you-know-how-to-report-bugs-and-give-suggestions.png"
/>
### Tip #6: Make sure when using backlog, the Product Owner will still get an email
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?](/when-you-use-mentions-in-a-pbi)
### Tip #7: Separate PBIs
If they are all related to one area, then you could consider putting them together. Otherwise don’t bunch them up.
See rules on [Do you send tasks one email at a time?](/do-you-send-tasks-one-email-at-a-time)
### Tip #8: Use emojis and prefixes for PBI/Issues titles, or email subjects
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 [which emojis to use in Scrum](/which-emojis-to-use-in-scrum).
<asideEmbed
variant="info"
body={<>
**Note:** [GitHub Issue Templates](/github-issue-templates) can help you with this.
</>}
figureEmbed={{
preset: "default",
figure: 'XXX',
shouldDisplay: false
}}
/>
acknowledgements
related rules