KISS (Keep It Simple) in Software Engineering - Mini Project: Build & Apply

Understanding KISS (Keep It Simple)

📖 Scenario: You are part of a software team that wants to improve code quality by following the KISS principle. Your task is to create a simple example that shows how to keep code easy to understand and maintain.

🎯 Goal: Build a small code example that demonstrates the KISS principle by creating a simple function and using clear, straightforward logic.

📋 What You'll Learn

Create a function with a clear name

Use simple and direct logic inside the function

Avoid unnecessary complexity or extra steps

Show how the function can be used with a simple example

💡 Why This Matters

🌍 Real World

Software developers use the KISS principle to write code that is easy to read, understand, and maintain, which reduces bugs and saves time.

💼 Career

Following KISS is a key skill for software engineers, improving teamwork and code quality in professional projects.

1

Create a simple function

Write a function called add_two_numbers that takes two parameters named num1 and num2. The function should return the sum of these two numbers.

Software Engineering

# Define the function add_two_numbers with parameters num1 and num2
# Your code here

Hint

Use the def keyword to define the function and return the sum directly.

2

Add a simple example call

Create a variable called result and assign it the value returned by calling add_two_numbers with arguments 5 and 3.

Software Engineering

def add_two_numbers(num1, num2):
    return num1 + num2

# Call add_two_numbers with 5 and 3 and store in result
# Your code here

Hint

Call the function with the numbers 5 and 3 and save the output in result.

3

Explain the simplicity

Add a comment above the function add_two_numbers explaining in one sentence that this function follows the KISS principle by doing one simple task clearly.

Software Engineering

# Add a comment explaining the simplicity of the function
# Your code here
def add_two_numbers(num1, num2):
    return num1 + num2

result = add_two_numbers(5, 3)

Hint

Write a short comment that says the function is simple and clear, following KISS.

4

Add a usage note

Add a final comment below the call to add_two_numbers explaining that keeping functions simple helps others understand and maintain code easily.

Software Engineering

# This function follows KISS by adding two numbers simply and clearly
def add_two_numbers(num1, num2):
    return num1 + num2

result = add_two_numbers(5, 3)
# Your code here

Hint

Write a comment that explains why simplicity is helpful in code.