CHAPTER 20
The Importance of Language
It doesn’t matter how good the content is if it isn’t written in a clear and concise way. One of the easiest tests is to read what you have written out loud to someone, even if it is your dog (dogs are great listeners but not so great at providing objective feedback). When they read their own documentation, most people tend to skip over parts without realizing that they are doing it so that it makes sense. Reading it out loud forces you to read every word and ensure that it is clear.
There are some words that should be avoided in writing documents. Any words or phrases that indicate disaster or blame should not be used:
• “You will miss your live date.” Instead try, “The priority 1 issues 23, 26, and ...
Get The Oracle Way to Consulting: What it Takes to Become a World-Class Advisor now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
