Transcript Insert Book Title Here

Parts of a User Manual


Criteria for writing a user manual
User manual components
1
Criteria for Writing a User Manual




Requires more detail than you can fit
into one instruction
Focus may vary: installation, operation,
maintenance, software use, etc.
Size may vary depending on topic
Includes instructions plus additional
components
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
2
Criteria for Writing a User Manual

Long User’s Manuals include all of the
topics already discussed:





Graphics
Hazards
Required tools
Detailed information geared toward the
audience
An appropriate style (numbered steps,
articles, verbs, personalization, etc.)
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
3
User Manual Components

Cover page






Topic – names product or service
Function (purpose)
Graphic
Table of contents
List of Figures
List of Tables
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
4
User Manual Components

Introduction / Overview / About this Manual






What do you need to know to make the best use
of this manual?
Personalized, positive tone
Emphasizes the value and importance of the
manual
How this manual is organized
How to use this manual
Special icons or symbols used in manual
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
5
User Manual Components

Glossary—define acronyms,
abbreviations, and high-tech terms


Alerts and special considerations


May be separate section or part of
overview
Warnings, hazards, dangers
Technical description (hardware)

Parts lists/accessories
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
6
User Manual Components


Instructions listed as tasks
Other possible sections:





Warranties/guarantees
FAQs
Troubleshooting
Corporate Contact information
Index
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
7
Components – Index




Might be in addition to the general end matter
Helps readers locate specific information
within a manual
Generally lists words and concepts
alphabetically
Identifies where readers can reference
information in the manual
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
8
Usability Testing

Usability Testing—another approach to
Revision:






Choose a test audience.
Ask the audience to test the instructions.
Monitor the audience. What challenges do the
instructions seem to present?
Time the team members as they attempt to
perform the tasks.
Quantify the audience’s responses. What problems
did they encountered.
Revise the instruction to improve its usability.
Gerson & Gerson: Technical Writing, 5th Edition
© 2006 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.
9