Get Rid of Jargon
 
Every occupation has jargon—police officers talk about trying to get a suspect to “flip” (turn state’s evidence), real estate agents complain about “fizbos” (houses For Sale By Owner, or FSBO), and chefs talk about “folding” eggs into a batter (just try folding a raw egg!) Jargon is a convenient shorthand for those within a particular industry or profession. But jargon can cause confusion if you let it slip into manuals. And if your manuals must be translated, jargon can really wreak havoc with meaning.

Whenever you are writing procedures or product descriptions, be sure that the terms you use are understood outside your own company. It’s ok to use technical language or standard industry terms as long as you are sure that your readers will understand them. But be on the lookout for terms that are specific to your own company or your own country. The easiest way to find jargon words in a manual draft is to have someone unfamiliar with your product—but comfortable with standard industry terms—read the draft and highlight any suspect words. Usually it is a simple matter to find alternatives that will clarify the text and reduce translation errors.