Debug scientifically

Try a more “scientific” process to solving bugs and reducing Mean Time to Recovery (MTTR)

Aug 27, 2022 4 min read

Bugs are inevitable

Working as a software engineer, we solve problems for our customers and stakeholders. Part of solving problems means new problems will arise. That’s good. The alternative is to never make progress: to never deliver new code to production. Some of the new problems will inevitably be bugs. We write automated tests to prevent bugs. We also write tests whenever a new bug is found, to prevent any regressions.

Mean Time to Recovery (MTTR)

The highest performance teams I’ve worked with have a bias towards action and progress. This means continuously deploying their code from main branch, aka “trunk based development”. They accept that there will occasionally be bugs. More important than not having any bugs is how fast bugs can be resolved, also known as Mean Time to Recovery (MTTR).

A “scientific” process to debug faster

Gather information

Goal: understand the size and scope of the bug as quickly as possible

Write down your hypothesis

For local development bugs, still write down your hypothesis in a scratchpad or note. Because you’ll repeat this process a few times it provides a good list of what you’ve tested already and eliminated as the root cause.

For production bugs, communication is key. Start or join a new thread to discuss only this bug. To start you can communicate something like: “I’m looking into this bug now”.

Then, for every hypothesis, post it to the thread.

Ask how can I disprove this hypothesis?

We don’t want to solve the wrong problem so it’s essential to think of a way to disprove the hypothesis. Is there an action or a change you can make that will disprove (“falsify”) your hypothesis?

Think of it as: “If I do action X, I expect to see Y”. X could be a code or config change and Y could be the bug disappearing or some related information changing.

Test it to disprove it, and eliminate that hypothesis

Do the test and write down the results.

Every single negative result is still valuable as you get closer and closer to identifying and fixing the root cause.

For production bugs, good communication means posting both the results of all tests to the thread.

Rinse and repeat to make progress

If the test disproved your hypothesis, then just start the process again. You now have more information. Use that information, or gather even more, to help generate a new hypothesis.

It’s good to have hypotheses that are incorrect. More important than figuring it out immediately systematically making progress. This type of progress will also feel good.

By communicating publicly, hopefully others can help you do this process. Or, at least learn the process so that next time they can lead it themselves.

Example

Here’s an example of what this might look in the Slack thread where someone posted a new bug. Annotations are marked as (...) for clarity:

(bug reported, replies below in a thread)…

Ok, I’m looking into this bug now.

Given A1 (information), my hypothesis is B1 is the root cause.

To test B1 (hypothesis), I’ll now do C1 (test #1) to disprove it. I’ll report my findings here.

Ok, we now know it’s not B1 (hypothesis), because of A2 (new information / result of C1 test)

My new hypothesis is B2.

To test B2 (hypothesis #2), I’ll now do C2 (test #2) to disprove it. I’ll report my findings here.

Ok, that was it. Now that I’ve done C2, the bug is fixed. I feel confident this is the root cause because of A3 (any new info)

I’ll mark this as closed in XYZ (error reporting tool)

References

Before getting a lot of practice with this myself, I first heard about a “Scientific method for dealing with bugs” at a Ruby Meetup talk in San Francisco, June 2018. I wish I knew the speaker’s name to give them credit.

While writing this up I also came across these similar articles:

Read more posts like this in the Software Engineering Toolbox collection.
Visit homepage
comments powered by Disqus