Abundant Mechanical Writing: Sell Your Readers On What’s Valuable
Overview
Our humdrum, sterile headings and writing process accomplish small to animate our Users to glance at parts of the product documentation that would be exceptionally benign for them. This article presents two real-world examples, how they fail their users, and how to right the problems.
Not the Legal & Disclaimers
Although the Legal and Disclaimer sections of your documentation are valuable for the protection of your corporation (and protection of your corporation should be a important ambition in your assignment), this is not what we are talking approximately here. Instead, we are discussing the File topics that are generally overlooked, however are valuable to your Users.
We will attending at two examples where the File writer should push the Reader to enquire supplementary information. My suggestion is to “post” the topics, by using alluring writing, to appetite the User to glance at the important topics.
A Law of (Writing) Activity
Provided a User knows one action to accomplish something, he/she is hesitant to bother learning approximately other ways. You, as a File writer, accept to sell the Reader on the benefits of the “other” (bigger) action.
Archetype: Microsoft Chat ™ Styles
Most ability users of Microsoft Chat ™ employ “styles,” rather than book formatting, to format their documents. Fresh and informal Users accomplish not understand approximately this able thing (available in most chat processors ). Chat’s User Documentation does small to animate the User to memorize approximately styles.
The Chat’s User File talks approximately manually formatting characters, paragraphs, etc. Subsequent in the file there is a cut on “styles.” However why should the User ever glance at that cut? Styles seem to be aloof another action of formatting characters, paragraphs, etc. The formatting cut aloof told them how to accomplish this.
Ability Users understand that for anything longer than a hardly any sheet mail, styles accommodate abounding benefits.
Documenter: Sell the Reader on valuable topics! Animate your User to glance at the supplementary information. Microsoft should accept added something love this last of the cut on book formatting:
“We reccomend that you employ ’styles’ to format any documents longer than a hardly any sheet mail. Look Page XX to memorize approximately styles.”
Archetype: Gas Barbeque Protected Shut Down
A Gas Barbeque User File headline says: “How to close Off Your Barbeque.”
The Reader Thinks: “I understand how to accomplish this,” and doesn’t glance at the information.
Provided your Users are doing matters unsafely or incorrectly then that bland headline will accomplish annihilation to advice them right their ways. Let’s best shot a added convincing headline for this:
“Most Bodies Shut Off Their Barbecues Unsafely: Here’s the Right Action”
Or much added focused:
“You Probably Shut Off Your Barbeque Unsafely: Here’s the Right Action”
This wording sounds love you are selling a product to the User. However you are not. You are using marketing techniques to receive Users to glance at valuable information.
Incidentally: Provided you accept a gas barbeque, compare how the directions impart you to close it off, versus how you indeed shut the barbecue off.
“Look Again” is also Bland
Don’t fall into the trap of simply adding “Look Again” sections where important. These are OK for telling the Reader where to acquisition supplementary advice, however accomplish annihilation to convince your Reader to glance at valuable supplementary information. Provided the information is of absolute help to the Reader then sell them on reading it. Compare these:
* Look Again: Styles, Page XX
* We reccomend that you employ “styles” to format any documents longer than a hardly any sheet mail. Look Page XX to memorize approximately styles.
Provided you were reading the User File, which of the above two headings would amuse you to memorize approximately styles? (Provided you gave the ‘amiss’ return, then buzz some other bodies;-)
The Backside Border
By selling the Reader on what you (or your man affair experts) accede valuable (beyond the legal and disclaimer statements) you are adding your experience to the file. In aftereffect, you are saying, “I anticipate you should glance at this topic as it may advice you.” That’s a acceptable object to affirm, exceptionally as it reflects your acceptable mind to your Reader.