1 User Documentation - Written Types of Written User Documentation (WUD)

2 What is Written UD? 4 Written User Documentation refers to the text and images used to describe the use or maintenance of a product. 4 It can be created using either paper or hypermedia. 4 It does not include sound or film.

3 What are some types of WUD? 4 User Reference Guides 4 Quick Reference Cards 4 Handbooks (Pocket Guides) Documentation for a software product may contain one or a combination of the following: 4 Keyboard templates 4 Wall Charts 4 Training Manuals

4 User Reference Guides 4 Enable users to learn a product 4 Provide accurate reference 4 Supply step-by-step detail about a task or menu path 4 Identify the users role in the entire product or system 4 Say WHY and HOW

5 Quick Reference Cards 4 List key functions 4 Act as a prompt 4 Summarise 4 Can be tailored to a specific need

6 Sample Reference Card

7 Handbooks 4 Summarise the key functions used by a specific target audience 4 Provide step-by-step instructions 4 Help the specific users use a product

8 Sample Handbook

9 Keyboard templates 4 Help users remember function keys on a standard keyboard 4 Need to be well designed

10 Wall Charts 4 Provide an overall view of the use of a product or system 4 Can used used by many users at one time 4 Are well received by users

11 Training Manuals 4 Are prepared when training is organised 4 Build user acceptance of a product 4 provide customised examples 4 Link to the reference guides 4 Provide a consistent training schedule 4 Practice the real world in a secure environment