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.
Subject:RE: Encouraging users to read online help From:SIANNON -at- VISUS -dot- JNJ -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 18 Dec 2001 10:26:58
Iggy says:
> Training shouldn't be required to teach people to use
> online help. At least, the help itself shouldn't
> require training.
...and training shouldn't be required to show a user how to open a program
from the start menu on a Windows box. Nevertheless it is, if the user
doesn't know how the start menu works. You have just illustrated my point
about assuming knowledge on the part of the user.
I just got out of a meeting (less than 15 minutes ago) with a bigwig of the
Documentation Control department (addresses documentation concerns and
revision control for all official docs in the company), where I was trying
to work out how to deal with multidimensional (non-linear-progression)
documents in the Doc Control repository/system they're using, which
converts all docs to a linear (nonhyperlinked) PDF for viewing by the
customer, while retaining the original format for export. I was explaining
our use of winhelp files for simple online training and reference, and
asked her to call up the file so she could see what I meant.
She didn't actually read the Contents page, which linked to the various
modules and explained how to use the browse sequences, before we went to
the revision history page. I asked her to go back to the Contents for a
moment, and she paused, trying to figure out how to do that (i.e., she was
unfamiliar with the use of the Contents buton). I went to show her the
browse sequences, and she appeared unfamiliar with them, as well. She knew
helpfiles exist, but seemed unfamiliar with the basic conventions of their
use,--and she's not a technophobic user, she just never needed to become
familiar with helpfiles before.
A couple years ago, while trying to explain something, I actually showed a
user the "Index" tab of an app's helpfile, and saw the stunned look of
surprise and happiness as she realized she could look things up with it.
She'd never known, and she'd been using Windows app's for years.
I used to receive the same call, monthly, from a user who would
consistently attempt to open Powerpoint files in Word. Even worse, it was
the *same* Powerpoint file, each time (for the monthly review of the org.
charts for four divisions).
I think this might be the same issue as whether a "conventions used in this
document" section is needed for a doc. Some folks say yes, some say no,
some say it depends. YMMV. Is your audience comfortable with using
helpfiles? If yes, they should require no training or additional
commentary. If they are *not* comfortable with helpfiles, then maybe a
little training or prompting is in order.
Shauna
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.