A great user manual educates people about product features, while teaching them how to use these features effectively. As an author, your ultimate goal is comprehension—you want readers to easily be able to read, reference, and absorb information.
But how can you make sure readers are soaking everything up? During our adventures creating Dozuki’s standard work instruction software, we’ve come across a few tips and tricks...
Define Your Audience
Know your reader—what is their experience level? where are they reading the manual?—and optimize your instructions to match their expertise. It can be helpful to create a written profile of your user, especially when you’re part of a team collaborating on documentation.
Describe the Problem
Explain the problem your manual aims to solve, present the solution, and then outline the instructions in order to attain the solution. It may sound obvious, but these are the three basic building blocks to any good user manual.
Break it Down
If the problem addressed in the manual is particularly complex, break it down into smaller parts. List each section with specific instructions. By breaking information down this way, you make the problems more approachable and easy to follow.
Vague words like "thing," "part," and "stuff" lead to ambiguous repair manuals. If you don't know what something is called, do your best to identify it by looking online or asking someone. Assembly may require several intricate parts—calling a part "this thing" doesn't help anyone!
Stick to the Topic at Hand
As much as people love anecdotes of your great-grandma putting ice cream in her purse (true story!), there's an appropriate setting for such stories. The middle of a user manual is not it.
Take Awesome Photos
Photos are the number one thing that draw people to your repair manual. Taking quality photos doesn’t demand expensive equipment—you can use your smartphone or a simple point and shoot camera. For easy tips on how to take good instructional photos, check out our free photography workshop.
Don't Use Passive Voice
Be direct in your instructions to the user—do not fall into the "It is" trap. Instead, use verbs to convey exactly what you're trying to say.
Avoid Using the First Person
There's no "I" in team, and there shouldn't be any in your writing. You have a more authoritative tone of voice by not using statements such as "I did this" in your manuals.
Use a Template
Standardizing your manual helps improve user comprehension and clarity. Things like consistent bullet-point styles, image sizes, and text orientation can help make browsing and following along easier for your readers. Looking for a program that makes standardizing manuals easy? Check out how Dozuki does it.
Minimize Background Info
A little background info is great: why you're doing this, who stands to benefit from the guide, what people need to do to prepare, etc. However, leave it at that. Most people shudder at the thought of reading a novel before diving into a guide. After all, when's the last time you read the full user manual that came with your TV?
Use Pictures to Orient Your Reader
When taking photos, the orientation of the object should remain consistent as much as possible throughout the manual. The reader will be able to identify his or her relative location with greater ease. If you rotate the object, include a statement such as "Flip the device" or "Rotate the device 90 degrees clockwise" to help the reader do the same and follow along.
Be Simple, Not Loquacious
People will not use your manual if they cannot understand what you're talking about, it isn’t Shakespeare.
Here at Dozuki, we see a lot of technical documents. In all of this written work, we inevitably...
The manufacturing industry is a professional arena with an overwhelming variety of industry...
How do I determine if electronic work instructions are needed in my organization? When should I...
With a background in design and communications, Leslie leads Dozuki's efforts to create and distribute valuable resources related to standard work, training, and lean manufacturing.