Software engineering principles - Step-by-Step Execution

Concept Flow - Software engineering principles

Identify Requirements

↓

Design Solution

↓

Implement Code

↓

Test Software

↓

Maintain & Improve

↓

Repeat Cycle for Updates

This flow shows the main steps guided by software engineering principles to build and maintain quality software.

Execution Sample

Software Engineering

1. Understand what users need
2. Plan how software will work
3. Write code carefully
4. Check code works well
5. Fix and improve over time

This sequence represents the practical application of software engineering principles in a project.

Analysis Table

Step	Action	Purpose	Outcome
1	Identify Requirements	Understand user needs	Clear goals for software
2	Design Solution	Plan software structure	Blueprint for coding
3	Implement Code	Write the program	Working software parts
4	Test Software	Find and fix errors	Reliable and correct software
5	Maintain & Improve	Update and fix software	Software stays useful
6	Repeat Cycle	Adapt to new needs	Software evolves over time

💡 Process repeats to keep software effective and up-to-date

State Tracker

Phase	Before	After Step 1	After Step 2	After Step 3	After Step 4	After Step 5
Software Quality	None	Requirements Clear	Design Ready	Code Written	Tested & Fixed	Maintained & Improved

Key Insights - 3 Insights

Why do we need to identify requirements before coding?

Without clear requirements (see Step 1 in execution_table), coding may not meet user needs, causing wasted effort.

What happens if testing is skipped?

Skipping testing (Step 4) risks releasing software with errors, reducing reliability and user trust.

Why is maintenance important after software is released?

Maintenance (Step 5) keeps software useful by fixing bugs and adapting to changes, preventing it from becoming outdated.

Visual Quiz - 3 Questions

Look at the execution_table, what is the outcome after Step 3?

A Clear goals for software

B Software stays useful

C Working software parts

D Blueprint for coding

💡 Hint

Check the 'Outcome' column for Step 3 in execution_table

At which step does the software become reliable and correct?

A Step 4

B Step 2

C Step 1

D Step 5

💡 Hint

Look for 'Test Software' and its outcome in execution_table

If we skip Step 5, what happens to software quality over time?

A It improves automatically

B It may degrade and become outdated

C It stays the same

D It becomes perfect

💡 Hint

Refer to variable_tracker row for 'Software Quality' after Step 5

Concept Snapshot

Software engineering principles guide building quality software:
1. Identify what users need
2. Design a clear plan
3. Write code carefully
4. Test to find errors
5. Maintain and improve over time
Repeat to keep software useful

Full Transcript

Software engineering principles help create and maintain good software by following steps: first, understand what users want; second, design how the software will work; third, write the code; fourth, test the software to find and fix problems; fifth, maintain and improve the software over time. This cycle repeats to keep software effective and up-to-date.

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