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: Making them read the documentation From:"Christensen, Kent" <lkchris -at- sandia -dot- gov> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 26 Apr 2001 13:56:00 -0600
(Digester chiming in a day late.)
Original poster (Sierra Godfrey) referred to "the most basic questions." So
... why not "Frequently Asked Questions" in the manual? The first thing in
the manual? Link to your beautiful step-by-step instructions from there.
(Creative indexing of questions required, obviously.)
Since I get the impression 99% of this discussion is about software manuals,
my comeback question would be ... Is your manual online and continually
updated to reflect questions received? (Kind of the definition of
"frequently asked," yes?)
A case could be made for the argument that the more emphasis your company
puts on telephone support the less faith it has in your manual in the first
place. But, others point out the different personality types (never use
manual) and I'd then ignore the argument because of that.
Speaking of personality types, there are also those who think some folks
actually prefer to answer their own questions and who try to avoid call-in
tech support at all costs. Old USAToday article on this: http://www.usatoday.com/money/tech/mtech061.htm
Except for situations in the military where manuals are used under order
(but where there is always a sargeant or chief to consult) and airlines, we
just have to assume we and our manuals aren't even nearly the end-all in all
of this and get on with our lives. As I've heard said in the government, "I
may be waste, but I'm not corruption."
(another who believes techwhirlers are really product designers--are we
designing the product so it can't be used without a manual?)
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
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.