Skip to main content

Tackling Technical Debt- Where to start?

Every software project accumulates technical debt. Like financial debt, it compounds over time if left unaddressed, making future changes increasingly difficult and expensive. But knowing where to begin tackling technical debt can be overwhelming.  As our time is limited, we have to choose wisely.

I got inspired after watching Adam Tornhill  talk called Prioritizing Technical Debt as If Time & Money Matters. So before you continue reading this post, check out his great talk:

Back? Ok, let’s first make sure that we agree on our definition of ‘technical debt’…

Understanding Technical Debt

Technical debt isn't just "bad code." It represents trade-offs made during development—shortcuts taken to meet deadlines, features implemented without complete understanding of requirements, or design decisions that made sense at the time but no longer fit current needs.

Technical debt manifests in several ways:

  • Code smells: Duplicated code, overly complex methods, and poor naming conventions
  • Architectural issues: Components that are tightly coupled, poorly defined boundaries, or misaligned with current business needs
  • Missing practices: Inadequate test coverage, outdated documentation, or manual deployment processes
  • Outdated dependencies: Frameworks, libraries, and tools that are no longer maintained or compatible with newer systems

Where to start?

OK, time to tackle the real topic of this post; where do we need to start when tackling technical debt? In a large and complex codebase there are typical a lot of places where technical debt can be found. The way that Adam explains in his talk is by looking for ‘hotspots’ in your code, code that changes a lot:

It doesn’t make much sense to tackle technical debt in code that is never touched or changed. However if you combine this change frequency with any of the available static code analysis tools available to identify technical debt, you can easily craft a list of places where to look first.

You can identify these hotspots in a (git) codebase directly using git:

git log --format=format: --name-only --since=12.month \
| egrep -v '^$' \
| sort \
| uniq -c \
| sort -nr \
| head -50

This will return the list of most frequently modified files in the last year based on the number of commits:

While writing this post, I found that there are multiple tools out there that can help you identify these hotspots. I tried Hotspot, a .NET Global tool that combines your git change history with some complexity metrics to identify possible hotspots.

I first installed the tool using:

> dotnet tool install -g hotspot
You can invoke the tool using the following command: hotspot
Tool 'hotspot' (version '0.0.4') was successfully installed.

Now I can invoke it using:

> hotspot recommend

I tried it on an (older) project and I got the following output:

 

Nice!

More information

Prioritizing Technical Debt as If Time & Money Matters • Adam Tornhill • GOTO 2022

Understanding Technical Debt

Lehman’s Laws of Software Evolution

Hotspots — CodeScene 1 Documentation

dburriss/hotspot: A dotnet command-line tool for analysing code risks like high complexity, size, and bus factor.

Labels:

Popular posts from this blog

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more