Crucial questions you must ask when it's
time to write the user manual
Crucial questions you must ask...
When it's time to write the user manual
"Does my staff have the time?"
As you know, writing, illustrating and designing a user manual is a project in itself. You've undoubtedly scheduled time for it and assigned someone to the job. But...
Experience tells you that high priority design and production issues will inevitably steal time away from the manual. With deadlines approaching, you have no choice—your staff must apply their expertise where it matters most.
As for the manual, you have an alternative: an outside firm can develop your user documentation. This approach frees your staff to focus their talents on essential product development tasks and urgent problems. Meanwhile, work on the manual can proceed independently. As a result, both your new product and its manual can be ready when planned.
What could your staff accomplish if they didn't have to create a manual?
"Does my staff have the skills?"
Writing an effective user manual requires:
- Mastery of the English language,
- An ability to craft simple, direct and logical instructions,
- A supportive style that helps users master your product,
- And a perspective that goes beyond the user to address your company's customer service and marketing interests.
Illustrating a user manual takes:
- An intuition for identifying topics that teach best in visual form,
- And a talent for translating those topics into clear graphic messages.
Designing a user manual involves:
- Harmonizing text and illustrations to guide users through every step,
- And creating pages that are attractive to the eye and stimulating to the mind,
- While balancing media specifications and delivery options.
How well can your staff perform these necessary documentation functions?
"Does my staff have the interest?"
Engineers, programmers and technicians spend years developing their talents in highly specialized fields. Creative by nature, your technical people could put together a user manual. But do they really want to?
Consider the effect on the technical specialist who is asked to write and publish a user manual—a task outside usual areas of experience and interest. Many product developers consider "technical writing" to be an unpleasant, unrewarding task. It's not what they aspire to do, nor what they trained to do.
Picture your customers, struggling through instructions penned by an uninspired writer. At best, users will muddle through. At worst, they will become ex-customers, trading your product for one that is friendlier and easier to understand.
How does your staff feel about writing and publishing a manual?
"Is there a better way?"
When you need a user manual and your staff doesn't have
the time
the skills or
the interest... I do!
I help you communicate effectively with the people using your products. Take advantage of my user-centered approach to manuals and...
- Your customers become competent users—which transforms them into product boosters.
- Your support costs are controlled because users resolve most problems before they call you.
- Your marketing department gains a persuasive new sales tool.
- Your company image is enhanced. A high quality manual reinforces your position as a superior vendor.
Maximize your product's market success with a user manual professionally produced by Stoneridge Technical Services!