ABSTRACT

Effective user manuals combine appropriate content with user-friendly organization and clear writing. User questions about the product and how to use it are a good guide to what to include in a manual (and what to omit). Sometimes information, especially safety information, must be repeated because users do not usually read a manual in its entirety. Rather they look for the specific information needed to complete a specific task. Manuals are best organized more like cookbooks than novels, with information presented in stand-alone modules rather than lengthy narratives. Effective writing strategies, including choosing an appropriate reading level, avoiding jargon and slang, and using straightforward, readable prose, will help ensure that the manual is user-friendly and accessible. Techniques such as presenting the big picture before details, using numbered lists for procedures, and ensuring smooth transitions from one sentence to the next improve readability.