Software reviews and inspections in Software Engineering - Mini Project: Build & Apply

Software Reviews and Inspections

📖 Scenario: You are part of a software development team that wants to improve code quality. Your team decides to organize a simple software review process to catch mistakes early and share knowledge.

🎯 Goal: Build a step-by-step outline of a software review process using clear, simple terms. You will create a list of review participants, set a review threshold, identify review steps, and finalize the review checklist.

📋 What You'll Learn

Create a list of review participants with exact names

Define a minimum number of reviewers required

List the main steps of a software review process

Add a final checklist item to complete the review

💡 Why This Matters

🌍 Real World

Software reviews and inspections help teams find and fix problems early, improving software quality and teamwork.

💼 Career

Understanding review processes is important for roles like software developers, testers, and quality assurance engineers.

1

Create the list of review participants

Create a list called reviewers containing these exact names: 'Alice', 'Bob', and 'Charlie'.

Software Engineering

# Create the list of reviewers
# Your code here

Hint

Use square brackets to create a list and separate names with commas.

2

Set the minimum number of reviewers

Create a variable called min_reviewers and set it to the number 2 to represent the minimum reviewers needed for a review.

Software Engineering

reviewers = ['Alice', 'Bob', 'Charlie']
# Set the minimum number of reviewers
# Your code here

Hint

Use a simple variable assignment with an integer value.

3

List the main steps of the software review

Create a list called review_steps with these exact steps as strings in order: 'Prepare', 'Review', 'Record', 'Rework', and 'Follow-up'.

Software Engineering

reviewers = ['Alice', 'Bob', 'Charlie']
min_reviewers = 2
# List the main review steps
# Your code here

Hint

Remember to keep the steps in the exact order given.

4

Add the final checklist item

Add a string 'Complete checklist' as the last item in the review_steps list to finalize the review process.

Software Engineering

reviewers = ['Alice', 'Bob', 'Charlie']
min_reviewers = 2
review_steps = ['Prepare', 'Review', 'Record', 'Rework', 'Follow-up']
# Add the final checklist item
# Your code here

Hint

Use the append method to add an item to the list.

Practice

1. What is the main purpose of software reviews and inspections?

easy

A. To find and fix errors early in the software development process

B. To write new code faster

C. To increase the number of features in software

D. To delay the release of software

Solution

1. Step 1: Understand the goal of reviews and inspections

   They are used to detect errors early before software moves to later stages.

2. Step 2: Compare options with this goal

   Only To find and fix errors early in the software development process matches the goal of early error detection and fixing.

3. Final Answer:

   To find and fix errors early in the software development process -> Option A

4. Quick Check:

   Early error detection = To find and fix errors early [OK]

Hint: Focus on early error detection as the key goal [OK]

Common Mistakes:

• Confusing reviews with coding speed
• Thinking inspections add features
• Believing reviews delay release

2. Which of the following best describes a software inspection?

easy

A. Writing automated tests for software

B. An informal meeting to discuss code improvements

C. A formal, structured process to find defects in software artifacts

D. Deploying software to production

Solution

1. Step 1: Define software inspection

   It is a formal and structured review process focused on finding defects.

2. Step 2: Match options to this definition

   Only A formal, structured process to find defects in software artifacts describes a formal, structured defect-finding process.

3. Final Answer:

   A formal, structured process to find defects in software artifacts -> Option C

4. Quick Check:

   Inspection = Formal defect finding [OK]

Hint: Remember inspections are formal, unlike informal reviews [OK]

Common Mistakes:

• Confusing inspections with informal meetings
• Thinking inspections are about testing
• Mixing deployment with inspections

3. During a software review, the team finds 5 errors in the design document and 3 errors in the code. What is the total number of errors found?

medium

A. 3

B. 8

C. 5

D. 15

Solution

1. Step 1: Identify errors found in design and code

   Design errors = 5, Code errors = 3.

2. Step 2: Add errors to find total

   Total errors = 5 + 3 = 8.

3. Final Answer:

   8 -> Option B

4. Quick Check:

   5 + 3 = 8 [OK]

Hint: Add all errors found in different artifacts [OK]

Common Mistakes:

• Counting only one type of error
• Multiplying errors instead of adding
• Ignoring errors in design or code

4. A team performs a software inspection but forgets to document the defects found. What is the main problem caused by this mistake?

medium

A. The team will write more code

B. The software will automatically fix defects

C. The inspection becomes informal

D. Defects may not be fixed because they are not recorded

Solution

1. Step 1: Understand the role of defect documentation

   Documenting defects ensures they are tracked and fixed later.

2. Step 2: Analyze consequence of missing documentation

   If defects are not recorded, they may be forgotten and remain unfixed.

3. Final Answer:

   Defects may not be fixed because they are not recorded -> Option D

4. Quick Check:

   Missing defect records = defects unfixed [OK]

Hint: Always document defects to ensure fixes [OK]

Common Mistakes:

• Assuming software fixes defects automatically
• Confusing inspection formality with documentation
• Thinking more code solves inspection issues

5. A software team wants to reduce costs and improve quality by catching errors early. Which approach should they prioritize?

hard

A. Conducting formal inspections and informal reviews regularly

B. Skipping reviews to speed up coding

C. Only testing after software is complete

D. Adding more features before fixing bugs

Solution

1. Step 1: Identify approaches that catch errors early

   Formal inspections and informal reviews help find errors early.

2. Step 2: Evaluate options for cost and quality impact

   Conducting formal inspections and informal reviews regularly supports early error detection, reducing costs and improving quality.

3. Step 3: Check other options

   Options B, C, and D delay error detection, increasing costs and reducing quality.

4. Final Answer:

   Conducting formal inspections and informal reviews regularly -> Option A

5. Quick Check:

   Early reviews = lower cost and better quality [OK]

Hint: Prioritize early reviews and inspections to save cost [OK]

Common Mistakes:

• Choosing to skip reviews
• Relying only on late testing
• Adding features before fixing bugs