Do you include URLs, screenshots, and code snippets in emails?

Last updated by Tiago Araújo [SSW] 23 days ago.See history

An email with just the word "Done" can often be enhanced with a screen capture or code snippet. Obviously this is also valid for tasks/requests.

In any email you send, include relevant information. Improved visibility and transparency will allow others to understand what was done or needs to be done straight away, such as:

  • URLs
  • Screenshots
  • Pieces of code/text

For screenshots of a browser window, include the top-left area - so others can see the URL and guess what browser was being used (e.g. Chrome or Edge).

Reduced cost of fixing bugs

The cost of a bug increases with the length of time it takes for the client to request a change. Providing an email with all the details helps others see the changes immediately. If they need further adjustments, addressing them on the same day is much cheaper than handling the same request two months later, when the context may be forgotten.

Finally, in the very unlikely case that the code repository and backup goes corrupt, the emails are a backup!

Figure: Bad example - "Done" email lacks details

Figure: Good example - "Done" email has a link, a screenshot (showing the URL), and code changes

More useful details to include

We open source. Powered by GitHub