Notes to Myself on Software Engineering

2 min readOct 22, 2024

Here are some key points to consider:

Best Practices

Separation of Concerns (SoC): Break down the system into smaller, independent components that handle specific tasks. This makes the code more maintainable, scalable, and easier to understand.
Don’t Repeat Yourself (DRY): Avoid duplicating code or logic. Instead, extract common functionality into reusable functions or classes.
Keep it Simple, Stupid (KISS): Favor simple, straightforward solutions over complex ones. This reduces the likelihood of bugs and makes the code easier to understand.
YAGNI (You Ain’t Gonna Need It): Don’t add features or functionality that aren’t currently needed. This helps avoid unnecessary complexity and reduces the risk of introducing bugs.

Single Responsibility Principle (SRP): A class or module should have only one reason to change.
Open-Closed Principle (OCP): A class or module should be open for extension but closed for modification.
Liskov Substitution Principle (LSP): Derived classes should be substitutable for their base classes.
Interface Segregation Principle (ISP): Clients should not be forced to depend on interfaces they do not use.
Dependency Inversion Principle (DIP): High-level modules should not depend on low-level modules, but both should depend on abstractions.

Write tests before writing code: This ensures that the code is testable and meets the required functionality.
Use a testing framework: Utilize a testing framework to write and run tests efficiently.
Debugging techniques: Use print statements, debuggers, or logging to identify and fix issues.

Follow a consistent naming convention: Use a consistent naming convention throughout the codebase.
Organize code into logical folders: Group related files and folders together to make the codebase easier to navigate.
Use version control: Utilize a version control system to track changes and collaborate with others.

Use clear and concise language: Avoid using jargon or technical terms that may be unfamiliar to others.
Document code and decisions: Write clear and concise documentation to explain the code and design decisions.
Communicate with team members: Regularly communicate with team members to ensure everyone is on the same page.

Stay up-to-date with industry trends: Regularly read blogs, articles, and books to stay current with the latest developments in software engineering.
Attend conferences and meetups: Attend conferences and meetups to network with other professionals and learn from their experiences.
Experiment with new technologies: Try out new technologies and tools to gain hands-on experience.

Is there a specific area you’d like me to elaborate on?

Like, Comment and Follow me for more daily tips.