How to write a perfect “bug” summary

When using Jira for a software project, you’ll be creating issues probably on a daily basis. What might be confusing after some time is to actually standardize a summary for the individual issues.

In this article I’ll try to have a look how to write a perfect summary for the issue type: bug.

What does it mean perfect?

In this article “perfect” means an ability of the person who is going to be assigned to the issue to quickly get a grip what the bug is all about.

How to do it?

Jira representatives state, that the ideal format is as follows:

<FEATURE> should do <X>, but does <Y>.

For example: “Submit button should submit form, but does nothing.”

In a simple terms it means that you should describe in a few words:

  • what should have been done
  • what is happening instead

Source:

  • Atlassian Jira Academy
Last updated: