Do you have templates for your PBIs and Bugs?

Updated by Brady Stroud [SSW] 1 year ago. See history

123

Bugs are often hard enough to resolve but when they don't detail how to reproduce the bug, or what the expected behaviour is, it wastes a lot of time and gets frustrating for the developers. Detail in a bug report is key to your teams effectiveness and success. This is not limited to bug reports, for example PBIs can be missing Acceptance Criteria. In Azure DevOps, a great way to ensure you capture all the information required is through templates for your work items. Templates allow you to guide users through all the required info in a clear and concise manner, ensuring you will always have clean and detailed steps to reproduce a bug.

❌ Figure: ![Bad example – This new bug template doesn’t make it obvious how the team likes their steps to repro](/uploads/rules/do-you-have-templates-for-your-pbis-and-bugs/templates for pbis and bugs - bad example.png)

✅ Figure: ![Good example – This new bug template guides the user to fill in the steps to repro in an ordered list and even prompts them to fill in what they expected to happen (and what actually happened)](/uploads/rules/do-you-have-templates-for-your-pbis-and-bugs/templates for pbis and bugs - good example.png)

Setting this up is pretty easy:

First you need to customize the template for a work item type

Figure: Customizing a bug work item

Choose the form control to edit

Figure: Set the default value for the Repro Steps field (Tip: use HTML)

Save Template

Sample code template

<!-- These comments automatically delete -->
<!-- **Tip:** Delete parts that are not relevant -->
<!-- Next to Cc:, @ mention users who should be in the loop -->

Cc:

<!-- add intended user next to **Hi** -->

Hi

### Describe the Bug

<!-- A clear and concise description of what the bug is. -->

### To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

### Expected Behavior

<!-- A clear and concise description of what you expected to happen. -->

### Tasks

- [ ] Investigate
- [ ] Fix

### More Information

<!-- Add any other context about the problem here. -->

### Environment

- Device: [e.g. iPhone 12]
- Browser: [e.g. chrome, safari]
- OS: [e.g. iOS]

### Screenshots

<!-- If applicable, add screenshots to help explain your problem. -->

Thanks!

Do you have templates for your PBIs and Bugs?

Sample code template

Categories