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:KMcLauchlan -at- chrysalis-its -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 18 Dec 2001 12:56:50 -0500
I may soon have to start creating Help for some of
our anticipated products, and I am daunted by the
prospect.
No, I have no worries about figuring out a HATT. My
worries are of a different order.
First, I imagine (for no good reason except that it's
somehow better than imagining the other possibility...)
that the creators of Help in general do so in good
faith.
But... my experience with Help has been the same
almost from the first time I ever encountered the
beast. Oh, certainly it has gotten prettier and
snazzier, and oh-thank-god quicker over the years,
but those were never the major issues for me.
Rather, it has been my experience that when browsing
for fun/interest, I find all sorts of neat things
in Help, that I may even remember when the day comes
to use them ... but when I dive into Help with a
specific need and a deadline looming, well suddenly
Help dries up.
It may be my peculiar brain. It may be bad habits
that I picked up in pre-historic times. But, when
the going gets tough, and the deadline draws nigh,
I find that the keywords I'm looking for are rarely
the ones that the Help is expecting. I may know what
I want, but I find myself asking the wrong questions
of the Help, and getting led astray. Even the time
it takes to go down the wrong paths is a nasty thing
under time constraints.
I especially like getting an error message, and then
not finding ANY keywords from that message in the Help.
It's nowhere in the Help index or contents, and a
search returns "no match for text string".
What, I'm the first person in the universe who ever
triggered that error? Fat chance... it's got a certain
well-worn aspect to it... Gotta love it.
So, my trepidation is at the prospect of doing that to
other people. Oy vei.
/kevin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author! iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,000 retailers. And it's
affordable. Join our almost 10,000 published authors today. http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.