Re: Reading Books vs. Asking Questions

Subject: Re: Reading Books vs. Asking Questions
From: Steven Brown <stevenabrown -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 28 Feb 2002 07:31:31 -0800 (PST)

<Chris discussed the use of FAQs in documentation.>

In my current position, I hear too many people
equating documentation with a list of FAQs. The anser
to each FAQ becomes a long paragraph with no context,
no formatting. The purchase of a knowledge base
(accessed via a natural language search engine) hasn't
helped matters; there's a risk of reducing every chunk
of information to a question and an answer.

We need to emphasize the 'F' in the FAQ. A
*frequently* asked question is one such as, "How do I
get to your store," or, "What are your hours of
operation?" It's not, "How do I configure the Acme
router when running a SolidState web server in a Unix
environment with an Oracle database?"

Don't even ask me about the proliferation of "best
practices," today's hot buzzword!

Steven Brown
Senior Technical Writer

Do You Yahoo!?
Yahoo! Greetings - Send FREE e-cards for every occasion!

Now's a great time to buy RoboHelp! You'll get SnagIt screen capture
software and a $200 onsite training voucher FREE when you buy RoboHelp
Office or RoboHelp Enterprise. Hurry, this offer expires February 28, 2002.

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 for more resources and info.

Reading Books vs. Asking Questions: From: Chris Knight

Previous by Author: Re: Are you a writer?
Next by Author: Re: How to keep a senior manager busy for hours on end.....
Previous by Thread: Reading Books vs. Asking Questions
Next by Thread: We be writers...

What this post helpful? Share it with friends and colleagues:

Sponsored Ads

Sponsored Ads