3 Benefits of Documenting Your Debugging Process

It may sound counterintuitive, but taking the time to document your debugging process will save you time--both now and in the future.

3 Benefits of Documenting Your Debugging Process

When troubleshooting an error, it's tempting to jump right into the code or the data to try to identify the problem.

However, taking the time to describe the problem first–and documenting the steps you take to resolve it–offers several benefits:

  1. The act of writing itself helps clarify your thinking and often leads to new insights
  2. It helps build a library of knowledge to reference in the future if (when) a similar problem occurs
  3. It provides documentation in case your client asks you to justify the time spent working on an issue

Number 1 saves you time in the present.

Number 2 saves you time in the future.

Number 3 is just a nice side benefit.

Image by Hagar Lotte Geyer from Pixabay

All original code samples by Mike Wolfe are licensed under CC BY 4.0