Checklist

Use this checklist to make sure that you have considered all the recommendations in this entry when developing your user manual:

The user manual:

complies with all labeling regulations.
is written for the type of people who use the device and tells the user how to get help from you..
includes a table of contents and has an alphabetized index.
has general warnings and precautions at the beginning.
describes the purpose of the device.
gives a physical description of the device with a graphic.
explains conditions under which the device should and should not be used.
gives clear setup instructions.
gives clear and easy to follow operating instructions.
provides cleaning instructions.
describes maintenance that the lay user must do.
explains storage.
has a clear, easy to use and find troubleshooting section.
explains disposal and recycling processes and obligations.
has a summary page with all the critical information on it.
has an easy to find date of printing.
includes instructions on any accessories.
has the necessary disclaimers and copyright notices (CE-Marking).
is laid out to make sections easy to find and update (tabs, binding, page numbering).
uses white space and other highlighting techniques to focus user attention on important information.
has clear, well-labeled graphics in key places to help user understand text.
is printed in proper contrast.

You have:

done a task analysis for the procedures in your user manual.
selected a suitable format (text, flowchart, list).
written and formatted procedures correctly.
used appropriate sentence construction and word choice.
tested your user manual to assure that properly written and placed specific warnings and cautions.
tested the user manual to make sure that your users can read, understand and follow it.
have taken steps to make sure that your user manual gets to your users.

For more details, see: