Having a meaningful bug title

A bug title is read more frequently than any other part of the bug report. So it has to be meaningful and easily understandable.

For example,

A bug : In the application while the user go to ‘xxx’ tab and search for an item with numeric characters, the app crashes

Poorly written bug title: App crashes

Here the bug title doesn’t summarize the scenario behind the crash

An average bug title: Searching in the ‘xxx’ tab leads to a crash

Here again the bug title is actually creating a false impression of the bug.

It could have better reworded like, “App crashes on searching in the xxx tab with numeric characters

Infact my suggestion would be to revisit and update the bug title finally, once the report is made fully.

After describing the issue, steps, expected and actual results, just look at the bug title. Definitely, you can do betterment on the same at the final stage.

So initially while starting to file the bug, just add a sentence or even some random keywords in the issue. Or even sometimes, just put whatever comes to your mind, say “my family”. [but of course don’t forget to change it properly at the end].

And finally, once the entire report is ready, revisit the bug title and update it properly. Spend a little more time on the issue title and have two or three revised titles so that it becomes fully meaningful at the end.

About

Akhila is the founder and sole contributor of wordsandnotion.com and qualitynotion.com. By profession she is a software Quality and Quantitative data analyst. She is a self motivated life long learner who loves to decode signs from the universe. Her weirdness is totally aligned with her real life stories and thought experiments. She is the author of “Know them, One answer to many questions” (a General Knowledge book) and “I Had a Crush - The 17 Kinks” (A free ebook of 17 short stories)

You may also like...

Leave a Reply