Thursday, September 19, 2013

A bug template to make everyone's life better

For logging a bug, the format that the data is in makes a huge difference in how fast someone can understand the problem.

This bug template has been created by iterative refinement via many many people across at least 5 companies.

Bug title:
[Area]: [operation] [causes/impacts] [type of failure (exception, log message)]

Bug body:
Environment (internal, cloud, local – add credentials if necessary)
-

Pre-Conditions
-

Steps to reproduce
-

Bug Description
-

Notes (Expected results, Workarounds, points of interest)
-

I hope that this gets used, and adopted and changed to make your life better.