Overview
Our humdrum, sterile headings and writing manner do little to encourage our Users to read parts of the product documentation that would be especially beneficial for them. This article presents two real-world examples, how they fail their users, and how to correct the problems.
Not the Legal & Disclaimers
Although the Legal and Disclaimer sections of your documentation are important for the protection of your company (and protection of your company should be a primary goal in your work), this is not what we are talking about here. Instead, we are discussing the Document topics that are often overlooked, but are important to your Users.
We will look at two examples where the Document writer should push the Reader to investigate additional material. My suggestion is to “advertise” the topics, by using tempting writing, to urge the User to read the relevant topics.
A Rule of (Writing) Life
If a User knows one way to do something, he/she is hesitant to bother learning about other ways. You, as a Document writer, have to sell the Reader on the benefits of the “other” (better) way.
Example:...