1 User Manual

2 A user manual is a technical communication document intended to give assistance to people using a particular system A user manual is a technical communication document intended to give assistance to people using a particular system Manuals can Manuals can Come with the product Come with the product Purchased separately Purchased separately Every manual will contain at least one instructions. Every manual will contain at least one instructions.

3 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

4 Cover Page Title of the manual Title of the manual Name of the product/service discussed Name of the product/service discussed Purpose of manual Purpose of manual Graphically depict the product or service Graphically depict the product or service Photograph Photograph Line Drawing Line Drawing

5

6 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

7 Hazard Alerts / Safety Guidelines Purpose Purpose Protect customer Protect customer Avoid equipment damage Avoid equipment damage Avoid lawsuits Avoid lawsuits Can be in the form of Can be in the form of List of safety tips List of safety tips Hazard alerts Hazard alerts

8

9 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

10 Table of Contents Identifies the placement of different sections of a manual Identifies the placement of different sections of a manual Helps the reader locate relevant information Helps the reader locate relevant information

11

12 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

13 Introduction Manuals may be the only contact between user and company Manuals may be the only contact between user and company Introduction must be friendly and positive. Introduction must be friendly and positive. Welcome to the world of modern electronics. The cordless phone you have purchased is the product of advanced technology. This manual will help you install your new phone easily.

14

15 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

16 Definition of Terminologies Readers unfamiliar with terminologies might Readers unfamiliar with terminologies might Miss important information Miss important information Perform an operation incorrectly Perform an operation incorrectly Define terms Define terms Early in the manual Early in the manual Throughout the text Throughout the text Glossary Glossary

17

18 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

19 Technical Descriptions Technical Descriptions help readers identify parts of a product Technical Descriptions help readers identify parts of a product It can be It can be Part by Part explanation Part by Part explanation Labeled Diagram of product’s components Labeled Diagram of product’s components List of product’s specifications List of product’s specifications Schematic diagram Schematic diagram

20

21

22

23

24 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

25 Warranties Warranties protect Warranties protect Customer: Customer: IF a product malfunctions sooner than mentioned by the manufacturer IF a product malfunctions sooner than mentioned by the manufacturer Manufacturer: Manufacturer: IF a product malfunctions after than mentioned by the manufacturer IF a product malfunctions after than mentioned by the manufacturer Disclaimers Disclaimers

26

27 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

28 Accessories Accessories are not mandatory for the product’s operations Accessories are not mandatory for the product’s operations A user manual may promote sale of accessories A user manual may promote sale of accessories

29 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

30 Frequently Asked Questions List of answered questions that are commonly asked by the customers List of answered questions that are commonly asked by the customers Saves company time and money Saves company time and money Improves customer relations Improves customer relations

31

32 Additional Components of a User Manual Cover Page Cover Page Hazard Alerts Hazard Alerts Table of Contents Table of Contents Introduction Introduction Definition of Terminologies Definition of Terminologies Technical Descriptions Technical Descriptions Warranties Warranties Accessories Accessories FAQ FAQ Corporate Contact Information Corporate Contact Information

33 Corporate Contact Information Most user manuals conclude by Most user manuals conclude by Giving telephone numbers Giving telephone numbers Addresses for local and regional service locations Addresses for local and regional service locations 24-hour service hotlines 24-hour service hotlines Consumer information bureau Consumer information bureau

34