It is critical that the instructions are easy to read and are understandable by all users.
#HELPNDOC VS HELP AND MANUAL MANUALS#
Consider the needs of disabled users (i.e., low vision, colour-blind) and provide alternative manuals in Braille, large print, audio etc.Make sure the writers have the product, understand the product, and actually use the product as they write.Write the user manual in synch with the product's development timeline not under pressure of shipping deadlines.Ensure that the writers are part of the product design team.but avoid marketing waffle (they already bought the product!)
#HELPNDOC VS HELP AND MANUAL HOW TO#
Tell the user what functions there are, and what they are for not just how to use them.Present instructions as step-by-step procedures.Make sure the instructions actually map on to the product in all respects.Provide a real (physical) user manual with the product: don't make people read a pdf.We have arranged the tips into the following sections: Our own experience of user testing various kinds of user manuals and documentation and seeing what works and what doesn't.Aspects of human perception, cognition and psychology as it pertains to reading.