1

User Documentation - Written

Types of Written User Documentation (WUD)

2

What is Written UD?

Written User Documentation refers to the text and images used to describe the use or maintenance of a product.

It can be created using either paper or hypermedia.

It does not include sound or film.

3

What are some types of WUD?

User Reference Guides Quick Reference Cards Handbooks (Pocket

Guides)

Documentation for a software product may contain one or a combination of the following:

Keyboard templates Wall Charts Training Manuals

4

User Reference Guides

Enable users to learn a product Provide accurate reference Supply step-by-step detail about a task or

menu path Identify the users role in the entire

product or system Say WHY and HOW

5

Quick Reference Cards

List key functions Act as a prompt Summarise Can be tailored to a specific need

6Sample Reference Card

7

Handbooks

Summarise the key functions used by a specific target audience

Provide step-by-step instructions Help the specific users use a product

8

Sample Handbook

9

Keyboard templates

Help users remember function keys on a standard keyboard

Need to be well designed

10

Wall Charts

Provide an overall view of the use of a product or system

Can used used by many users at one time Are well received by users

11

Training Manuals

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

environment