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.

Related Posts

Welcome to in28Minutes

One Stop for all your Java Spring Courses!

Design Patterns For Beginners - with Java Examples

In this guide, we give you an introduction to the world of design patterns.For each pattern, we understand 1) the pattern a2) the context in which it is applicable - with a real-world example.

Software Design - Encapsulation - with examples

Encapsulation is one of the important goals of Software Design. What is Encapsulation? Why is it important? Let's get started.

Software Design - How do you keep your design simple?

With extreme programming and agile, the focus is being lean and keeping your design simple. In this context, how do you ensure that your design remains good and evolves along with the application requirements? Here are a five tips you can focus on.

Software Design - What is Abstraction?

Abstraction is one of the fundamental concepts of software engineering. It is all about hiding complexity while building your application.

Software Design - Cohesion - with examples

High Cohesion is one of the important aims when your architect and design your software. What is it all about?

Software Design - Coupling - with examples

Software architects and programmers love low coupling. What is coupling? Why is coupling important? Let's get started.

Software Design - Introduction to Evolutionary Design

With extreme programming and agile, the focus is being lean and doing just in time design. In this context, how do you ensure that your design remains good and evolves along with the application requirements?

Software Architecture - Why do we use Layered Architectures?

In this article, we explore the reasons why we build applications with several layers. We also look at different options for each layer in the Java world.

5 Qualities of a Great Software Architect

In this article, we look at some of the important qualities of a great software architect. While we focus on application architects, most of these are applicable for enterprise architects as well.