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


Image Image


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.

Free Courses - Learn in 10 Steps

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.

Related Posts

Docker Tutorial for Beginners - with Java and Spring Boot

Learn about Docker - What is Docker? Why Is Docker Popular? How to create Docker Image for a Java Spring Boot App?

Devops Tutorial | DevOps with Docker, Kubernetes and Azure DevOps

What is DevOps? How is it different from Agile? What are the popular DevOps Tools? What is the role of Docker, Kubernetes and Azure DevOps in DevOps. Let's get started with a simple usecase.

Deploy Java Spring Boot Applications to AWS, Azure, GCP with Docker and Kubernetes

In this article, we focus our attention on the cloud. How to learn the cloud and deploy Java Spring Boot Applications to AWS, Azure, GCP with Docker and Kubernetes?

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.

Microservices with Spring Boot and Java - Part 1 - Getting Started

Let's learn the basics of microservices and microservices architectures. We will also start looking at a basic implementation of a microservice with Spring Boot. We will create a couple of microservices and get them to talk to each other using Eureka Naming Server and Ribbon for Client Side Load Balancing. In part 1 of this series, lets get introduced to the concept of microservices and understand how to create great microservices with Spring Boot and Spring Cloud.

20+ Spring Boot Projects with Code Examples

At in28Minutes, we have created more than 20 projects with code examples on Github. We have 50+ articles explaining these projects. These code examples will you learn and gain expertise at Spring Boot.

REST API Best Practices - With Design Examples from Java and Spring Web Services

Designing Great REST API is important to have great microservices. How do you design your REST API? What are the best practices?

Index - 500+ Videos

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 React Java Full Stack Application with Maven

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

Creating a SOAP Web Service with Spring Boot Starter Web Services

Let's learn how to create a SOAP Web Service with Spring Boot Starter Web Services. We will take a Contract First approach by definining an XSD and exposing a WSDL from it.

FREE COURSES



in28Minutes Best Selling Udemy Courses

Image Image Image Image Image Image Image Image Image

450,000 Learners are pursuing our 31 amazing courses and 6 Learning Paths. Start Now!

Join 450,000 Learners and 30+ Amazing Courses

LEARN DEVOPS - 200+ VIDEOS - Master DevOps with Docker, Kubernetes and Azure DevOps


350,000 Learners are learning everyday with our Best Selling Courses : Spring Boot Microservices, Spring, Spring Boot, Web Services, Hibernate, Full Stack React, Full Stack Angular, Python, Spring Interview Guide, Java Interview, Java Functional Programming, AWS, Docker, Kubernetes, PCF, AWS Fargate and Azure


85,000 Subscribers are learning from our Free Videos on YouTube : JSP Servlets, Spring, Spring Boot, Spring MVC, Hibernate, Eclipse, Maven, JUnit, Mockito, Full Stack - React, Full Stack - Angular, Docker, Kubernetes, AWS, AWS Fargate, PCF and Azure


Here are the recommend articles to read next : Spring Interview Questions, Spring Boot Interview Questions, Microservices, Hibernate, Spring Security, REST API with Spring Boot, Full Stack with React, SOAP Web Services, Exception Handling, Embedded Servers, Spring Data Rest, Spring vs Spring MVC vs Spring Boot, Building Web Application and Spring Data JPA.

You can checkout all our 100+ articles here - All Articles.


Do not know where to start your learning journey? Check out our amazing learning paths:
Learning Path 01 - Spring and Spring Boot Web Applications and API Developer,
Learning Path 02 - Full Stack Developer with Spring Boot, React & Angular,
Learning Path 03 - Cloud Microservices Developer with Docker and Kubernetes,
Learning Path 04 - Learn Cloud with Spring Boot, AWS, Azure and PCF and
Learning Path 05 - Learn AWS with Microservices, Docker and Kubernetes


Subscribe