CS 411W

1. CS 411W IX – Users Manuals

2. Product User Manual Examples • Automobile Owners Booklet • Video Gaming Systems (PS-2, XBOX, etc.) • Cellular Phone Booklets • Board Game Instructions • Computer Peripheral Installation Guides

3. Significance of the Users Manual • The Good: Good user documentation informs the user how to perform a procedure as well as when it should be performed, the expected results, and how to address error conditions. • The Bad: Too frequently the user is frustrated at having to refer to the manual in the first place, frustrated because the manual can't be found, and finally frustrated because the information can't be found in the manual….

4. Characteristics of a Good Users Manual • Describes the product • Includes system organizational diagrams • Provides system subassemblies and diagrams • Includes illustrations/screen dumps/entry sequences • Provides understandable directions • Explains the proper/safe use of the product • Utilizes common language and defined terms

5. Considerations for Developing a Good Users Manual • Write to the appropriate level for the expected audience or user community • Assume the user is completely unfamiliar with the product • Organization and format must be logical and easy to follow • Use examples and simple sentence constructs (I.e. avoid long, complex explanations) • Make use of illustrations, screen dumps, tables

6. Considerations for Developing a Good Users Manual (Cont) • Start at the beginning (power up/ logon sequence, initial setup etc.) • Make sure entry and action sequences are complete • Identify error conditions and how to respond to them

7. Key Areas to Address • Introduction • Overview of the product • Clear statement of the intended audience and purpose • What does the reader need to know before reading? • What is the manual's context? • What notations are used? (Try to use standard notations) • Equipment and supporting system requirements • Limitations

8. Key Areas to Address (Cont) • Getting Started • System setup information • Logging on • What the user will see first/what to do next • Sample run • Exiting (how to return to exit point and properly exit system/software, etc.)

9. Key Areas to Address (Cont) • Operating Instructions – Overall Content • Individual instructions for each capability or component Address all screens, buttons, switches, lights, and knobs Identify error conditions limitations Show branches to other capabilities Identify exit points or termination/cancellation options • Include a Chart of Actions or Action/Response Matrix • Use illustrations, screen dumps, callouts

10. Key Areas to Address (Cont) • Operating Instructions – Information to Include • Background information • Prerequisites • Directions • Results • Next steps

11. Example – Choosing HTML Files Screen Dump with Callouts

12. Example – Choosing HTML FilesInstructions for Screen Dump Callouts • Start by clicking on the Book radio button (1) to specify you'll be converting one or more HTML files into a book. • Your next step is to choose one or more files for conversion by clicking on the Add Files... button (2). • The File Chooser dialog box will appear. • When the File Chooser dialog appears, pick the file(s) you wish to convert and then click on the OK button. • If you don't see the file that you want, double click on the folder with ../ after it.

13. Example – Choosing HTML Files (Cont)Instructions for Screen Dump Callouts • Product XYZ can automatically create a title page for you. Fill in the Title File/Image field or click the Browse... button (3) to locate the file you want to use. • If you don't see the file you want, double click on the folder with ../ after it.

14. User Manual – Overall Format Considerations • Format Look and Feel (I.e. Presentation is Important) – Consider the following: • Is the manual attractive? • Does it have good use of color? • Does it use diagrams to convey overall understanding of architecture, relationships between capabilities, etc.? • Does it use screen displays/help screens to enhance understanding?

15. User Manual – Overall Format Considerations (cont) • Are different fonts used to distinguish text, user input and output? • Are special fonts used to highlight commands for easy access? • Is there effective use of borders, top line of page, etc. used as visual aids to enhance speed of use as reference?

16. User Manual – Overall Format Considerations (cont) • Is it hard bound? online? DVD? • If hardbound – is it easy to use (spiral bound), appropriately structured (heavy paper, laminated, etc.)? • If online or DVD – does it include simulated action sequences, video examples, interactive tutorials?

17. LAB IV – Users Manual • Will address the prototype functionality • Will draw heavily on documents completed to date • Should provide comprehensive instructions on how to operate major functions of your prototype by someone who is not intimately familiar with it.