Why Software engineering principles? - Purpose & Use Cases

The Big Idea

What if your software project could avoid costly mistakes and deliver on time every time?

The Scenario

Imagine building a large house without any blueprint or plan. Each worker does their own thing, and the materials arrive randomly. The result is chaos, delays, and a house that might collapse.

The Problem

Without clear principles, software projects become slow and full of mistakes. Developers waste time fixing bugs, rewriting code, and struggling to understand each other's work. This leads to frustration and failed projects.

The Solution

Software engineering principles act like a solid blueprint. They guide developers to write clean, organized, and reliable code. This makes teamwork easier, reduces errors, and speeds up building great software.

Before vs After

✗ Before

Write code without planning, fix bugs repeatedly, no clear structure

✓ After

Follow principles like modularity and testing to build reliable software fast

What It Enables

It enables teams to create complex software efficiently and confidently, delivering value to users faster.

Real Life Example

A team building a banking app uses principles like code reuse and testing to ensure money transfers are safe and the app works smoothly for millions of users.

Key Takeaways

Software engineering principles prevent chaos and confusion in projects.

They help write clean, reliable, and maintainable code.

Following these principles leads to faster, better software development.

Practice

1. Which software engineering principle encourages writing code that does one thing and does it well?

easy

A. Open/Closed Principle

B. Don't Repeat Yourself (DRY)

C. Single Responsibility Principle (SRP)

D. Keep It Simple, Stupid (KISS)

Solution

1. Step 1: Understand the principle names

   SRP means each module or class should have one responsibility or reason to change.

2. Step 2: Match the description to the principle

   Writing code that does one thing well matches SRP.

3. Final Answer:

   Single Responsibility Principle (SRP) -> Option C

4. Quick Check:

   One responsibility = SRP [OK]

Hint: One job per module means SRP [OK]

Common Mistakes:

• Confusing SRP with DRY which avoids repetition
• Thinking KISS means single responsibility
• Mixing Open/Closed with SRP

2. Which of the following is the correct description of the DRY principle?

easy

A. Avoid duplicating code or logic in multiple places

B. Keep code as simple as possible

C. Design software to be open for extension but closed for modification

D. Each class should have only one reason to change

Solution

1. Step 1: Recall DRY meaning

   DRY stands for "Don't Repeat Yourself", meaning avoid code duplication.

2. Step 2: Match option to DRY

   Avoid duplicating code or logic in multiple places says avoid duplicating code or logic, which matches DRY.

3. Final Answer:

   Avoid duplicating code or logic in multiple places -> Option A

4. Quick Check:

   DRY = no repetition [OK]

Hint: DRY means no repeated code [OK]

Common Mistakes:

• Confusing DRY with Open/Closed principle
• Mixing DRY with KISS which is about simplicity
• Thinking DRY means single responsibility

3. Consider this code snippet applying the KISS principle:

def calculate_area(radius):
    return 3.14 * radius * radius

area = calculate_area(5)
print(area)

What will be the output?

medium

A. 31.4

B. 78.5

C. Error due to missing import

D. None

Solution

1. Step 1: Calculate area using formula

   Area = π * radius² = 3.14 * 5 * 5 = 3.14 * 25 = 78.5

2. Step 2: Check code output

   The function returns 78.5 and print outputs it.

3. Final Answer:

   78.5 -> Option B

4. Quick Check:

   3.14 * 25 = 78.5 [OK]

Hint: Multiply π by radius squared for area [OK]

Common Mistakes:

• Using 2 * π * r (circumference) instead of area formula
• Expecting error due to missing math module (not needed here)
• Confusing output with None from missing return

4. Identify the error in this code violating the Open/Closed Principle:

class Shape:
    def area(self, shape_type, size):
        if shape_type == 'circle':
            return 3.14 * size * size
        elif shape_type == 'square':
            return size * size
        else:
            return 0

medium

A. The class is closed for modification

B. The method is open for extension without changes

C. The code uses inheritance properly

D. The area method uses conditional logic to handle multiple shapes

Solution

1. Step 1: Understand Open/Closed Principle

   It says software entities should be open for extension but closed for modification.

2. Step 2: Analyze the area method

   The method uses if-else to handle different shapes, so adding a new shape requires modifying this method.

3. Final Answer:

   The area method uses conditional logic to handle multiple shapes -> Option D

4. Quick Check:

   Conditional logic breaks Open/Closed [OK]

Hint: If-else for types breaks Open/Closed [OK]

Common Mistakes:

• Thinking inheritance is used properly here
• Believing the class is closed for modification
• Confusing open for extension with modifying code

5. You want to refactor this code to follow the Single Responsibility Principle (SRP):

class User:
    def __init__(self, name, email):
        self.name = name
        self.email = email
    def save_to_database(self):
        # code to save user data
        pass
    def send_welcome_email(self):
        # code to send email
        pass

What is the best way to apply SRP here?

hard

A. Move save_to_database to a separate DatabaseHandler class

B. Keep all methods in User class since they relate to user

C. Combine both methods into one method for simplicity

D. Remove send_welcome_email method entirely

Solution

1. Step 1: Understand SRP

   SRP says a class should have only one reason to change, so User should only hold user data.

2. Step 2: Identify responsibilities

   Saving to database and sending emails are separate concerns from user data storage.

3. Step 3: Refactor accordingly

   Move save_to_database to a DatabaseHandler class to separate concerns.

4. Final Answer:

   Move save_to_database to a separate DatabaseHandler class -> Option A

5. Quick Check:

   Separate responsibilities = SRP applied [OK]

Hint: One class, one reason to change means separate concerns [OK]

Common Mistakes:

• Keeping all methods in one class breaks SRP
• Combining methods increases complexity
• Removing functionality instead of refactoring