How to write the bug report of software test?

Catalog

One 、 Preface

Two 、 What is? bug？

3、 ... and 、 What is? bug The report ？

Four 、Bug Key elements in the report

5、 ... and 、 How to determine a Bug Importance ？

6、 ... and 、 for instance

7、 ... and 、 summary

---

One 、 Preface

Bug The report is the focus of the test , Whether oral or written , Are the most obvious results of the test .

The quality of the report is probably the most important factor in determining the credibility of the tester , A good one Bug The report can not only reflect the professionalism of testers , It can also facilitate developers or other relevant personnel to quickly obtain Bug Related information , It helps to Bug Evaluate the importance of and quickly repair .

Two 、 What is? bug？

In the popular sense ,Bug Is to affect the normal use or friendly use of the product , Defects that affect the value of the product .

Bug It can be divided into two kinds ： normal Bug And enhanced demand Bug.

natural Bug It means that the product fails to realize its own function ; And enhanced demand Bug It's a problem when you think the requirements themselves should be improved or optimized .

let me put it another way ,“ The product doesn't work as you expected ” It's a common Bug“, The product has realized the functions you need , But when you think there can be a better implementation , This leads to enhanced demand Bug.

for instance ：

• Let's say I have a web application , Click the button and there is no response , So this is a normal Bug;
• If you click the button, there is a response , But when you think the button icon or form can be better , What you put forward at this time Bug It can be called enhanced demand Bug.
•  

                         

 

3、 ... and 、 What is? bug The report ？

Bug A report is a description of a suspicious error .

The most basic Bug The report states that :“ I think there may be some problems with the product .” in real life , This can be expressed as simply pointing to the screen and saying :“ Oh , Look at it. , That's a Bug.”

in fact , When you're testing for a friend standing next to you , All you need to do is let them know what your product should be 、 What to do . If we are all close friends , Or we have the same understanding , that Bug The report will be very easy .

Bug The report can be formal or informal 、 Written or oral . Even the simplest Bug The report , Its foundation also has the following four elements ：

01

Describe the problem you perceive

What problems did you encounter during the test , specifically 、 To be clear . Ask yourself , Is this the root of the problem , Or is this the final question , Or whether there is a bigger 、 The more fundamental problem is . for example ： You can describe “ I didn't respond when I clicked this button “.

02

How did you encounter this problem

What you perceive Bug This is based on direct observation of the product itself . Specify the steps and data you use .

for example ： What kind of data is input in what step to generate this Bug, This is an occasional Bug It's also a frequent Bug, Do you have any screenshots or videos , What data do you use , What documents , What exactly did you enter ?

03

Why is it a question

Explain how you identify the problem , It can be a requirement document , It can also be some standards and specifications, etc .

for example ： The problem phenomenon is inconsistent with the demand —— function Bug, Or excessive resource consumption when problems occur —— performance Bug.

04

Why is this an important question

Your client may need to know ： This is a big Bug Or a little Bug？ You should be ready to explain Bug How important it may be , The importance is related to the possibility of its discovery and the degree of damage it may cause when it occurs .

for example ： You can describe “ This is a serious Bug, Grade is L1, Because of this Bug The occurrence of causes the system to jam and cannot operate normally ”.

Four 、Bug Key elements in the report

The following is the official Bug The most common fields in the report ：

01

title

describe Bug A brief summary of the essence ：

• The length should not be too long

Generally speaking , The title shall not exceed 12 A word is better .

• The title is unique

Every Bug The title can be distinguished from other titles . for example , Do not write “ Product crash ” This generic title .

02

describe

Any other information about specific failure modes and behaviors ：

• Keep the description as short as possible

Give relevant Bug Reasonable details of , But don't include information that everyone on the team must know . If the problem is obvious , for example “ The company name is misspelled on the home page ”, Then you hardly need to write a description .

• Describe as professionally as possible

Not in one Bug The report covers a number of issues .

Non multiple problems may be a symptom of a potential failure in the product , Otherwise, they should be divided into different error reports . This is because developers can easily fix a problem , And accidentally forget to fix other problems listed in the same report .

• Try to describe the important steps

Don't provide obvious steps , for example :

1. Connect to Internet;

2. Launch the browser .

• Describe what you think is Bug Why

This means explaining why you think this is a Bug, Unless it's obvious . Don't say “ The product should not crash ” Such vague nonsense . This description is meaningless .

You can add a little you know Bug Solutions for .

                       

 

03

edition

Pay attention to the version information you tested .

Be careful ： If the same Bug Appears in multiple versions , Will be Bug Link to the most important version .

for example ：Bug A In the development version Develop V1 And release Release V2 At the same time , Please write the version information in the description Release V2. Because important version information is used , It can greatly arouse the concern of developers and managers Bug Focus on .

04

Environmental Science

The platform you tested . for example ： Hardware 、 Information such as browser and operating system .

05

The attachment

Can help understand and analyze Bug Some of the logs of 、 Screen capture 、 Recording screen, etc .

In addition to the above basic fields ,Bug Tracking system （ Such as jira） There may be other fields . It will automatically fill ID、Reporter and Date Reported Field , And the state 、 Severity and priority, etc .

5、 ... and 、 How to determine a Bug Importance ？

The tester is judging Bug“ How big is the ” The first person . For responsible testers , This is a very important part of your work .

So how to determine a Bug The importance of ？ You can refer to these aspects ：

01

Bug Frequency of occurrence

Under the same conditions , One that is often seen by many users Bug Will become more important . Whether there are many different types of events that can trigger this Bug？ Whether it is extremely vulnerable to trigger events ？ How obvious it is when it appears ?

02

How much damage will it cause when it happens

Although for which specific symptoms “ More serious damage ” There are no strict rules , But try visualizing the problem , Then consider the importance of the affected users .

The most important mistakes are usually those that hinder the project itself ： It's called blocking error , These are things that prevent you from testing or normal user use Bug.

for example ” The software crashes and doesn't work properly “, Of such phenomena Bug Can be called the most important Bug, Secondly, it will have some impact on users' use, but it will not be unusable Bug.

03

Bug There are other potential risks

Bug May be particularly important , Because it means that there is a big problem in the development process itself , May lead to many similar Bug It has not been found .

04

Bug What kind of negative impact will it bring to the product

Although some Bug Objectively, it's not that serious , for example ： It does not hinder the normal use of the product . however , It will affect the user's favor and trust in the product , Well, it's also a serious problem at this time Bug.

6、 ... and 、 for instance

With jira Tools, for example , Reports a system crash caused by a concurrent request Bug. The key information is as follows 1 Shown .

jira The default version is included 、 Environmental Science 、 Priority and other information for users to choose , Therefore, in the description part, we can only focus on Bug Description of its own information , Such as ： Recurrence frequency 、 Reproduction steps, etc .

In the reproduction step , Adopted Given——When——Then How to describe , It can make the description more concise and logical , I recommend you to use .

7、 ... and 、 summary

This paper mainly introduces the report Bug Some key points and details to pay attention to , I hope I can help you .

A good one Bug The report , It can make our testers more professional , It can also shorten developer troubleshooting time Bug And repair Bug Time for , Happy you and me . I hope it gave you an idea ~

        

 

Thank everyone who reads my article carefully ！！！

If you can use the following information, you can take it away directly ：

1、 Self study development or test the necessary complete project source code and environment

2、 Test all templates in the work （ test plan 、 The test case 、 Test report, etc ）

3、 Classic interview questions for software testing

4、Python/Java Automation test practice .pdf

5、Jmeter/postman Interface test full set of video acquisition

I personally sorted out some technical materials I have sorted out in my software testing career in recent years , contain ： e-book , Resume module , Various work templates , Interview treasure , Self study projects, etc . If you encounter problems in your study or work, you can directly join the group and ask , There will also be great gods in the group to help solve ,

Click the link to join the group chat 【python Automated test communication 】https://jq.qq.com/?_wv=1027&k=sdqWN7kr