11

User ManualUser Manual

22

User ManualUser Manual A user manual is a technical communication A user manual is a technical communication

document intended to give assistance to people document intended to give assistance to people using a particular system using a particular system

Manuals can Manuals can Come with the productCome with the product Purchased separatelyPurchased separately

Every manual will contain at least one Every manual will contain at least one instructions.instructions.

33

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

44

Cover PageCover Page

Title of the manualTitle of the manual Name of the product/service discussedName of the product/service discussed Purpose of manualPurpose of manual

Graphically depict the product or serviceGraphically depict the product or service PhotographPhotograph Line DrawingLine Drawing

55

66

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

77

Hazard Alerts / Safety GuidelinesHazard Alerts / Safety Guidelines

PurposePurpose Protect customerProtect customer Avoid equipment damageAvoid equipment damage Avoid lawsuitsAvoid lawsuits

Can be in the form ofCan be in the form of List of safety tipsList of safety tips Hazard alerts Hazard alerts

88

99

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

1010

Table of Contents Table of Contents

Identifies the placement of different sections Identifies the placement of different sections of a manualof a manual

Helps the reader locate relevant informationHelps the reader locate relevant information

1111

1212

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

1313

IntroductionIntroduction

Manuals may be the only contact between user Manuals may be the only contact between user and companyand 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.

1414

1515

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

1616

Definition of TerminologiesDefinition of Terminologies

Readers unfamiliar with terminologies might Readers unfamiliar with terminologies might Miss important informationMiss important information Perform an operation incorrectlyPerform an operation incorrectly

Define termsDefine terms Early in the manualEarly in the manual Throughout the textThroughout the text GlossaryGlossary

1717

1818

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

1919

Technical DescriptionsTechnical Descriptions

Technical Descriptions help readers identify Technical Descriptions help readers identify parts of a productparts of a product

It can be It can be Part by Part explanationPart by Part explanation Labeled Diagram of product’s componentsLabeled Diagram of product’s components List of product’s specificationsList of product’s specifications Schematic diagramSchematic diagram

2020

2121

2222

2323

2424

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

2525

WarrantiesWarranties

Warranties protect Warranties protect Customer: Customer:

IF a product malfunctions sooner than mentioned by the IF a product malfunctions sooner than mentioned by the manufacturermanufacturer

Manufacturer:Manufacturer: IF a product malfunctions after than mentioned by the IF a product malfunctions after than mentioned by the

manufacturermanufacturer DisclaimersDisclaimers

2626

2727

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

2828

AccessoriesAccessories

Accessories are not mandatory for the Accessories are not mandatory for the product’s operationsproduct’s operations

A user manual may promote sale of A user manual may promote sale of accessoriesaccessories

2929

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

3030

Frequently Asked QuestionsFrequently Asked Questions

List of answered questions that are commonly List of answered questions that are commonly asked by the customersasked by the customers

Saves company time and moneySaves company time and money Improves customer relationsImproves customer relations

3131

3232

Additional Components of a User Additional Components of a User ManualManual

Cover PageCover Page Hazard AlertsHazard Alerts Table of ContentsTable of Contents IntroductionIntroduction Definition of TerminologiesDefinition of Terminologies Technical DescriptionsTechnical Descriptions WarrantiesWarranties AccessoriesAccessories FAQFAQ Corporate Contact InformationCorporate Contact Information

3333

Corporate Contact InformationCorporate Contact Information

Most user manuals conclude byMost user manuals conclude by Giving telephone numbersGiving telephone numbers Addresses for local and regional service locationsAddresses for local and regional service locations 24-hour service hotlines24-hour service hotlines Consumer information bureauConsumer information bureau

3434