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


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.

Best Selling Udemy Courses

Image
Image Image Image Image Image Image Image Image Image

Join 450,000 Learners and 30+ Amazing Courses

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


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

FREE COURSES



Related Posts

Writing Integration Tests for Rest Services with Spring Boot

Setting up a basic REST Service with Spring Boot is a cake walk. We will go one step further and add great integration tests!

Integrating Spring Boot and Spring JDBC with H2 and Starter JDBC

Learn using Spring Boot Starter JDBC to connect Spring Boot to H2 (in memory database) using Spring JDBC. You will create a simple project with Spring Boot. You will add code to the project to connect to a database using Spring JDBC. You will learn to implement the basic CRUD methods.

JUnit Tutorial for Beginners in 5 Steps

JUnit Tutorial for Beginners in 5 Steps. Setting up a basic JUnit example and understanding the basics of junit.

JPA and Hibernate Tutorial For Beginners - 10 Steps with Spring Boot and H2

JPA and Hibernate in 10 Steps with H2 - Setting up a basic project example with Spring Boot and in memory database H2. Its a cake walk.

Spring Boot Tutorial For Beginners in 10 Steps

Introduction to Spring Boot in 10 Steps. Learn the basics of Spring Boot setting up a basic project example with Spring Boot.

Spring Framework Tutorial for Beginners - Your First 10 Steps

Learn the basics of Spring Framework setting up a very simple example.

JPA and Hibernate Tutorial using Spring Boot Data JPA

Complete journey starting from JDBC to JPA to Spring Data JPA using an example with Spring Boot Data JPA starter project. We use Hibernate as the JPA Implementation.

Creating a Web Application with Spring Boot with JSP

Setting up a basic web application with Spring Boot is a cake walk. We will create a simple web application using Spring Initializr and add JSP features to it.

What is Spring Boot Auto Configuration?

Auto Configuration is the most important feature in Spring Boot. In this tutorial, we will learn important concepts about Auto Configuration with a couple of examples.

Unit Testing Rest Services with Spring Boot and JUnit

Setting up a Basic REST Service with Spring Boot is a cake walk. We will go one step further and add great unit tests to our RESTful Service.


Search