Defect reporting best practices in Testing Fundamentals - Build an Automation Script

Report a defect with clear and complete information

Preconditions (2)

Step 1: Open the defect tracking tool

Step 2: Create a new defect report

Step 3: Enter a clear and concise summary of the defect

Step 4: Provide detailed steps to reproduce the defect

Step 5: Attach screenshots or logs if available

Step 6: Set the defect severity and priority

Step 7: Assign the defect to the appropriate developer or team

Step 8: Save and submit the defect report

✅ Expected Result: Defect report is created with all necessary information to allow developers to understand, reproduce, and fix the issue

Automation Requirements - None (manual process)

Assertions Needed:

Verify defect summary is not empty

Verify reproduction steps are detailed and clear

Verify attachments are included if applicable

Verify severity and priority are set

Verify defect is assigned correctly

Best Practices:

Use clear and simple language

Include exact steps to reproduce

Attach evidence like screenshots or logs

Set correct severity and priority

Assign to the right person or team

Avoid vague descriptions

Keep defect reports concise but complete

Automated Solution

This topic is about manual defect reporting best practices, so no automation code is applicable.

However, testers should always follow the steps to create a defect report that is clear, complete, and actionable. This helps developers fix issues faster and improves communication.

Common Mistakes - 5 Pitfalls

{'mistake': "Writing vague defect summaries like 'App not working'", 'why_bad': 'Developers cannot understand the problem or reproduce it easily', 'correct_approach': "Write clear summaries like 'Login button does not respond when clicked on Chrome browser'"}

Skipping reproduction steps

Not attaching screenshots or logs

Setting incorrect severity or priority

Assigning defect to wrong person or team

Bonus Challenge

Create a checklist template for defect reporting that includes all best practices

Show Hint

Practice

1. Which of the following is the most important information to include in a defect report?

easy

A. Number of team members working on the project

B. Steps to reproduce the defect

C. Tester's personal opinion about the software

D. The color scheme of the application

Solution

1. Step 1: Understand the purpose of a defect report

   A defect report should help developers find and fix the problem quickly by providing clear information.

2. Step 2: Identify key information needed

   Steps to reproduce the defect allow developers to see the problem themselves, which is essential.

3. Final Answer:

   Steps to reproduce the defect -> Option B

4. Quick Check:

   Include reproduction steps = C [OK]

Hint: Always include how to reproduce the defect [OK]

Common Mistakes:

• Including irrelevant personal opinions
• Omitting reproduction steps
• Ignoring environment details

2. Which format is best for writing the 'Expected Result' in a defect report?

easy

A. A clear, specific statement like 'The login button should redirect to the dashboard.'

B. A list of unrelated features.

C. A long paragraph about the software's history.

D. A vague description like 'It should work better.'

Solution

1. Step 1: Understand the role of 'Expected Result'

   The expected result tells what should happen if the software works correctly.

2. Step 2: Choose the clear and specific statement

   A clear, specific statement like 'The login button should redirect to the dashboard.' clearly states what the correct behavior is, helping developers understand the issue.

3. Final Answer:

   A clear, specific statement like 'The login button should redirect to the dashboard.' -> Option A

4. Quick Check:

   Expected result must be clear and specific = D [OK]

Hint: Write expected results clearly and specifically [OK]

Common Mistakes:

• Being vague or unclear
• Adding unrelated information
• Writing too much unnecessary detail

3. Given the following defect report snippet, what is missing?

Title: App crashes on clicking 'Save'
Steps:
1. Open app
2. Enter data
3. Click 'Save'
Actual Result: App crashes

medium

A. Environment details like OS and app version

B. Steps to reproduce the defect

C. Actual result description

D. Title of the defect

Solution

1. Step 1: Review the defect report snippet

   The snippet includes title, steps, and actual result but no environment details.

2. Step 2: Identify missing key information

   Environment details (like OS, app version) help reproduce the defect accurately.

3. Final Answer:

   Environment details like OS and app version -> Option A

4. Quick Check:

   Missing environment info = A [OK]

Hint: Always include environment details in defect reports [OK]

Common Mistakes:

• Forgetting environment info
• Assuming steps are enough
• Ignoring actual result clarity

4. A tester writes this defect report:

Title: Error message shown
Steps:
1. Click 'Submit'
2. See error
Expected Result: No error
Actual Result: Error message appears

What is the main problem with this report?

medium

A. The actual result is missing

B. The expected result is incorrect

C. The steps are too vague and not detailed enough

D. The title is too long

Solution

1. Step 1: Analyze the steps provided

   The steps only say 'Click Submit' and 'See error' without details like what page or data was entered.

2. Step 2: Understand why detailed steps matter

   Without clear steps, developers cannot reproduce the defect reliably.

3. Final Answer:

   The steps are too vague and not detailed enough -> Option C

4. Quick Check:

   Vague steps cause confusion = A [OK]

Hint: Write detailed, clear steps to reproduce defects [OK]

Common Mistakes:

• Writing vague reproduction steps
• Ignoring environment info
• Not specifying expected results clearly

5. You are reporting a defect that happens only on mobile devices running Android 12. Which combination of details is best to include in your defect report to help developers fix it quickly?

hard

A. Only the error message text and your phone brand

B. Expected result and a list of all tested devices

C. Steps to reproduce and a long history of previous defects

D. Steps to reproduce, expected vs actual results, device model, OS version, and a screenshot

Solution

1. Step 1: Identify key details for mobile-specific defects

   Device model and OS version are critical to reproduce issues on specific platforms.

2. Step 2: Combine with clear reproduction steps and evidence

   Including steps, expected vs actual results, and a screenshot gives full context for developers.

3. Final Answer:

   Steps to reproduce, expected vs actual results, device model, OS version, and a screenshot -> Option D

4. Quick Check:

   Complete details + environment + evidence = B [OK]

Hint: Include environment, steps, results, and screenshots for clarity [OK]

Common Mistakes:

• Omitting device or OS details
• Providing incomplete reproduction steps
• Not attaching helpful evidence like screenshots