USER

MANUAL
English
User Manual A user manual is a document provided to
instruction manual a user that helps in using a particular
system, product or service seamlessly.
user guide
 • Instruction Manual - basic instructions that tells
users how best to use a product
• Training Manual - set of instructions that tell
users how to complete a job, process or task

Types of • Service Manual - set of instructions guiding

users on how to keep machinery running

Manuals • User Manual - documents that assist users

with the operation of a product
• Operation Manual – set documentation of
company’s information including roles,
responsibilities and processes
Good User Manual (1)
• Plain language
• Be clear, simple, and easy to understand, without requiring a
dictionary
• If use technical term, use glossary
• Avoid abbreviation if possible
• Explain symbols, icons and codes early

• Readable Visuality
• Adding relevant images, diagrams and videos
• Clear visual step instruction
Good User Manual (2)
• Logical hierarchical structure
• Should have a logical hierarchical
• Start from unboxing end with troubleshooting

• Organized Content
• Searchable content
• clear topics
• don’t have too many levels of subtopics
• simple and easy to follow
 Present “You can delete Servers data”
Tenses in User make it passive! into
Manual
“Server data can be deleted”
The user manual should be
translated to the
language(s) of the country
where the product is sold.
To create an internationally compliant user manual, you
should always make sure your manual meets the EU, US
and 82079 requirements
Information in User Manual
• Product name • Troubleshooting section and
• Model or type number instructions on how to solve problems
• Intended use • Maintenance information
• Features/accessories • Repair information
• Description of the main product • Information on disposal of the product
elements and packaging
• Description of the user interface • Technical specifications
• Safety warnings • Table of content
• Installation instructions • Index
• Description of how to use/operate the • Glossary
product • Warranty information
• Contact details
 Write the safety
warnings based on
the risk analysis
WARNING! Rotating parts. Risk of serious injuries.
`
Keep hands clear. Lockout/Tagout before servicing.