Software Design - Five Things To Look Out For In A Design Review


You are invited to do a design review for an important project.

  • Where do you start?
  • What do you look for?

Doing a software design review is never a straightforward task, with a number of things to look out for. In this short article, we look at five such aspects, which will help you structure your review process in a better way.

Software Design

This is the last article in a series of articles on Software Design:

Do you have good high level architecture?

I would start with looking at the high level architecture. Understand the business context of the application. Understand Choice Of Layers And Responsibilities

  • Are we making the right choice in number of software layers
  • Does each layer have its own responsibility?
  • Do we have too few layers?
  • Are we making the design too complex?
  • Are we making the right choice of responsibility for each layer?
  • Are we creating good APIs? Are we exposing functionality in the right way?

Are you choosing the right frameworks and tools?

The second thing I would look at is the choice of frameworks and tools.

  • Are we choosing the best framework options?
  • Does it fit in with the enterprise guidelines of the organization?
  • Are the chosen frameworks appropriate for the domain in which the software is being developed?
  • Are we making the best use of those frameworks?

Do you have Great Unit Tests?

This might be a surprise but I’m a great believer that great applications have great unit tests.

In order have the design of your software to be always evolving, you need an awesome set of unit tests.

Unit Testing Golden Rule : Are you able to understand the scenario being tested in less than a minute?

If you are, that’s awesome. If you are not, this might indicate

  • Lack of Single Responsibility
  • Complex Dependencies or
  • Bad Unit Tests

Any of the above is a bad omen.

Is the readability of code good?

The next thing I would look at is the readability of source code. Am I able to look at a piece of code and understand it quickly?

If you are, that’s awesome. If you are not, this might indicate

  • Bad Coding Practices
  • Lack of Single Responsibility
  • Complex Dependencies

Are you using and creating reusable components?

The last thing I would focus on is Reusability. You don’t want to build everything on your own. Do you? You want to use open source frameworks and also frameworks available in your enterprise. And you might also want to contribute to the frameworks in your enterprise.

Here are somethings look at?

  • Can I use other common components present in the enterprise?
  • Can some part of what we are building (for example authentication, database framework etc) be re-used across the enterprise? Can we create a common component?
  • Are we making the right use of such common components?

Do check out our video on this:

image info

Summary

In this article, we looked at how you can do a quick design review for a new project.

Do you look for anything else in a quick review? Leave a comment.

10 Step Quick Introductions to Frameworks

Related Posts

Spring Boot Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. This resources will help you learn and gain expertise at Spring Boot.

Spring and Spring Boot Video Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. Here's a list of video tutorials and courses for you

Creating Spring Boot and Vue JS CRUD Full Stack Application with Maven

This guide helps you create a full stack application with all the CRUD (Create, Read, Update and Delete) features using Vue JS as Frontend framework and Spring Boot as the backend REST API. We use Maven as the build tool.

Software Design - Separation Of Concerns - with examples

Software architects and programmers love having Seperation of Concerns. What is it? Why is it important? Let's get started.

Object Oriented Software Design - Solid Principles - with examples

Software design is typically complex. Object oriented design takes it to the next level. There are a number of design patterns and other stuff to be aware of. Can we make things simple? What are the goals to aim for when you are doing object oriented design? SOLID Principles is a great starting point for Object Oriented Design.

Software Design - Open Closed Principle - with examples

Open Closed Principle is one of the SOLID Principles. You want your code to be easily extended. How do you achieve it with minimum fuss? Let's get started.

Software Design - What is Dependency Inversion Principle?

Dependency Inversion Principle is one of the important SOLID Principles. Dependency Inversion Principle is implemented by one of the most popular Java frameworks - Spring. What is it all about? How does it help you design good applications?

Introduction to Four Principles Of Simple Design

With agile and extreme programming, the focus is on keeping your design simple. How do you keep your design simple? How do you decide whether your code is good enough?

Software Design - Single Responsibility Principle - with examples

For me, Single Responsibility Principle is the most important design principle. What is Single Responsibility Principle? How do you use it? How does it help with making your software better? Let's get started.

What is an In Memory Database?

In this article, we understand what the term "In-Memory Database" actually means. We see what scenarios they can be used, and why they are important.