Secret ingredients to quality software


Do you use indentation for readability?

Last updated by Tiago Araújo [SSW] on 06 Apr 2021 10:06 pm (about 1 month ago) See History

Written communication can easily cause misunderstandings. Help the reader understand your message better by:

  • Using “>” and indentation when quoting the text from others, like the original email you are replying to, or a web page, etc.
  • Your new text should be kept to the left
  • Optionally, use a different text color in your reply
  • Add numbers if the sender didn't and it is appropriate

This way you won't forget any questions in the original email.

Figure: Bad Example - there's too much information here

Figure: Good Example - You can clearly see the context of each part of the reply

Note: For those using mobile devices the indentation function is not available, try instead using 3 spaces to indent manually.

Adam CoganAdam Cogan
Cameron ShawCameron Shaw
Paul NeumeyerPaul Neumeyer
Tiago AraujoTiago Araujo

We open source. This page is on GitHub