Bug Report Template

The author of the book Deep Work talks about The Principle of Least Resistance.

The Principle of Least Resistance: In a business setting, without clear feedback on the impact of various behaviors to the bottom line, we will tend toward behaviors that are easiest in the moment.
— Cal Newport - Deep Work

Shitty internal bug reports are an example of this. Over the years I've seen so much time and money wasted from badly written bug reports. The amount of back and forth between developer and reporter can really rack up.

The text is wrong colour
— CEO's bug report
I can’t create X
— Developer Y bug report

 

How To Encourage Good Bug Reporting

Provide Real Examples

Choose a real bug report that someone or yourself filed and go through it, looking at it's good and bad points.

Write Good Bug Reports Yourself

If you're writing bug reports for others, write really well detailed ones. It won't take long before they realise how useful it is.

Introduce a Template

Below is the bug report template I've used for the last few years. I usually customise it slightly depending on the project (iOS or macOS? Is there a dev server? etc). In the past I've also created a bookmarklet that automatically fills the text area of whatever tool we're using.


## iOS Version

## Build Version

## Device

## Server

## Login Details

## Is it reproducible?

Yes / Occasionally / One Time / No

## Steps to Produce/Reproduce

1. ...
2. ...
3. ...

## Expected Results

## Actual Results

## Workarounds

## Other Information

Daily Standups

I’m a big fan of daily standups. Not the annoying let’s have a call/stand in a circle ones, but the low friction, doesn’t matter what time zone you’re in standup’s. They let you set targets for your day, reflect on yesterday and keep your team in the loop about how things are going and if you are blocked on anything. Not to get all motivational and shit, but there is a reason behind why well accomplished individuals swear by setting one or two major goals for the day.

Even if you work by yourself it’s worth trying out. Developers are known for being terrible at estimating the time it takes to complete tasks. This is a good way to actually see what you got done yesterday and helps you adjust your own internal estimating system.

My Standup Template

Yesterday

  • a - (link to ticket)
  • b - (link to ticket)
  • c - (link to ticket)

Today

  • 1 - (link to ticket)
  • 2 - (link to ticket)

Blockers

  • Name A - (link to ticket)
  • Name B - (link to ticket)

Documentation

I’ve worked with many companies over the years. The companies that work really well (remote or not) and can do a lot with a little (money and people) are the ones that document well.

By documentation, I mean asynchronous communication with your team:

  • Daily stand-ups. (the written type, not the “let’s disturb everyone to have a call” type)
  • Bug reports
  • Bug report updates
  • Labelling in Sketch files
  • Product roadmap
  • New feature ideas/research
  • Employee handbook
  • Shared password manager
  • Deployment logs
  • Commit messages
  • etc…

Writing documentation can be seen as a waste of time or money, however I have yet to see a instance where it has not made an improvement.

Next time someone interupts you by tapping you on the shoulder or @’ing you in Slack it might be worth making that knowledge more accessible.

Crypto Telegram Bot

 
9ff2f2f01c4bd1b013.png
 

All the Telegram crypto price tracker bots really suck, so I had a little play around with the bot API this evening and have managed to throw together something simple but useful (I think!)...

To use the bot either visit here or search for the user @CryptoPriceTrackerBot.

Then just type:

/[currency code] e.g. /xrp, /btc, /ltc

Thanks to KC for letting me use his face for the icon.