Bug report writing in Testing Fundamentals - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a bug report?

A bug report is a document that describes a problem found in software. It helps developers understand and fix the issue.

beginner

Name three key parts of a good bug report.

A good bug report includes: 1) Clear description of the problem, 2) Steps to reproduce the bug, 3) Expected and actual results.

beginner

Why is it important to include steps to reproduce in a bug report?

Steps to reproduce help developers see the problem themselves. Without them, it is hard to find and fix the bug.

beginner

What should you avoid when writing a bug report?

Avoid unclear language, missing details, and blaming others. Stay factual and polite to help fix the problem quickly.

beginner

How can screenshots or videos help in a bug report?

Screenshots or videos show exactly what happens. They make it easier to understand the bug and speed up fixing it.

What is the main purpose of a bug report?

A To describe a software problem clearly

B To praise the software features

C To confuse developers

D To delete the software

A bug report's main purpose is to clearly describe a problem so developers can fix it.

Which part is NOT usually included in a bug report?

A Steps to reproduce

B User's personal opinion about the developer

C Actual result

D Expected result

Bug reports should be factual and polite, not personal opinions about developers.

Why should you write clear steps to reproduce a bug?

A So developers can see the bug themselves

B To make the report longer

C To confuse testers

D To hide the bug

Clear steps help developers reproduce and understand the bug to fix it.

What is a good way to help explain a bug visually?

A Use emojis only

B Write only text

C Include screenshots or videos

D Send a blank report

Screenshots or videos show exactly what happens and help developers understand the bug.

Which tone should you use when writing a bug report?

A Sarcastic

B Blaming and rude

C Vague and unclear

D Polite and factual

A polite and factual tone helps the team work together to fix the bug.

Explain the key elements you should include when writing a bug report.

Think about what helps a developer understand and fix the bug.

Describe why clear communication and tone matter in bug report writing.

Imagine how you want to be treated when someone reports a problem to you.

Practice

1. What is the main purpose of writing a bug report in software testing?

easy

A. To clearly explain the problem and how to reproduce it

B. To praise the software for its features

C. To describe the software's design

D. To list all the software's functions

Solution

1. Step 1: Understand the role of a bug report

   A bug report is meant to communicate a problem clearly so developers can fix it.

2. Step 2: Identify the correct purpose

   Among the options, only explaining the problem and how to reproduce it matches the bug report's goal.

3. Final Answer:

   To clearly explain the problem and how to reproduce it -> Option A

4. Quick Check:

   Bug report purpose = clear problem explanation [OK]

Hint: Focus on clear problem explanation and reproduction steps [OK]

Common Mistakes:

• Confusing bug report with feature description
• Writing vague problem statements
• Ignoring reproduction steps

2. Which of the following is the correct way to write the 'Expected Result' in a bug report?

easy

A. The software crashes sometimes.

B. The software is slow.

C. I don't like how the software looks.

D. The software should save the file without errors.

Solution

1. Step 1: Understand what 'Expected Result' means

   It describes what should happen when the software works correctly.

2. Step 2: Choose the option that clearly states the correct expected behavior

   The software should save the file without errors. clearly states the expected behavior: saving the file without errors.

3. Final Answer:

   The software should save the file without errors. -> Option D

4. Quick Check:

   Expected result = correct software behavior [OK]

Hint: Expected result shows correct behavior, not opinions [OK]

Common Mistakes:

• Writing vague or subjective expected results
• Confusing actual and expected results
• Skipping expected result section

3. Consider this bug report snippet:

Steps to reproduce:
1. Open the app
2. Click 'Save'
3. Observe error message

Expected result:
File saves successfully

Actual result:
Error message 'Save failed'

What is the main problem this bug report helps identify?

medium

A. The save function shows an error instead of saving

B. The app crashes on startup

C. The error message text is correct

D. The app saves files too quickly

Solution

1. Step 1: Analyze the steps and results

   The steps show clicking 'Save' leads to an error message instead of saving.

2. Step 2: Match the problem with options

   The save function shows an error instead of saving correctly describes the issue: save function shows error instead of saving.

3. Final Answer:

   The save function shows an error instead of saving -> Option A

4. Quick Check:

   Bug report identifies save error issue [OK]

Hint: Match steps and results to find the problem [OK]

Common Mistakes:

• Ignoring actual vs expected results
• Misreading the steps
• Choosing unrelated options

4. A tester writes this bug report:

Steps:
1. Login
2. Click 'Profile'
3. See blank page

Expected: Profile page loads
Actual: Blank page

What is missing that would improve this bug report?

medium

A. The tester should add unrelated screenshots

B. The tester should remove the expected result

C. The tester should add environment details like browser and OS

D. The tester should write a longer story

Solution

1. Step 1: Review the bug report content

   The report has steps, expected and actual results but lacks environment details.

2. Step 2: Identify what improves bug reports

   Adding environment details helps developers reproduce and fix bugs accurately.

3. Final Answer:

   The tester should add environment details like browser and OS -> Option C

4. Quick Check:

   Environment details improve bug reports [OK]

Hint: Always include environment info for better bug reports [OK]

Common Mistakes:

• Skipping environment details
• Adding irrelevant information
• Ignoring clear reproduction steps

5. You find a bug that only happens when the user uploads a file larger than 5MB on a slow internet connection. What is the best way to write this bug report?

hard

A. Report the bug without any reproduction steps.

B. Report the bug with steps, expected vs actual results, and mention file size and network speed.

C. Report the bug but say it happens on all file sizes.

D. Report only that the upload fails without details.

Solution

1. Step 1: Identify key details for reproduction

   File size and network speed are important to reproduce this bug.

2. Step 2: Choose the option that includes clear steps and environment details

   Report the bug with steps, expected vs actual results, and mention file size and network speed. includes steps, expected vs actual results, and important conditions.

3. Final Answer:

   Report the bug with steps, expected vs actual results, and mention file size and network speed. -> Option B

4. Quick Check:

   Include all relevant details for complex bugs [OK]

Hint: Include all conditions that trigger the bug [OK]

Common Mistakes:

• Omitting important reproduction conditions
• Giving vague or incomplete steps
• Ignoring environment factors