Friday, August 27, 2021

Technical documentation pet peeve:

If you write something like:

An error is recorded indicating "system failure."

Instead of (note placement of period):

An error is recorded indicating "system failure".

The error had better SHOW "system failure." WITH THE PERIOD.  If not, put the friggin period after the quote.  I don't care what idiocy (you think) you were taught in school about moving the punctuation inside the quote.  What goes inside the quotes, if you are using quotes, had better match exactly.

That is all.

No comments: