TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I am currently re-writing one of our large user guides into a more friendly "How-To" format.
You could try something like that.
You could also try doing a series of very short videos, with each video containing one "How-To."
And by the way, I never read the manual, either!
Craig
-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of David Tinsley
Sent: Tuesday, September 16, 2014 12:13 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: FW: Getting users to RTFM
Hi,
I am after some opinions from fellow tech writers. We produce fairly complex spatial measurement systems that require a considerable understanding of the technology before they can be used in any meaningful way. My tech support colleagues continually get calls from customers for which the response is RTFM. The manuals do contain all the information needed, but it seems the customers would rather pick up the phone to tech support. We have been brainstorming ways of making it less intimidating for the customer to find information in the manuals. We deliver pdf, fully indexed, cross referenced and with a comprehensive logical TOC.
One idea the tech support folk had was to incorporate some kind of "landing page" on the pdf with a "What do you want to do" kind of thing with links to the appropriate section. To my way of thinking we already have that in the TOC and this would just introduce yet another layer of information that would be ignored.
So, after all the preamble my question is this: What successful methods have you implemented to persuade the user to search for the information in the manuals?
David (who never reads manuals unless it is to critique them!)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l
