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: FAQs in User Guides From:"Elliott C. Evans" <eeyore+ -at- cmu -dot- edu> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 02 Jan 2001 19:28:34 -0500
Chuck Martin wrote:
> I just encountered a question that I have never had asked before, nor seen
> it dealt with here or elsewhere: Should a FAQ page be a part of a User Guide?
[...]
> I'm inclined a bit toward the "no" side, thinking that the FAQs should be
> answered in the manual contect, and of course be well indexed so they answers
> can be easily found. Thoughts?
Perhaps, if you know that certain sections of the manual answer questions that
are more frequently asked, a second "index" would be helpful. It should probably
be shorter than a full page, simply contain FAQs and page references. e.g.:
How do I set the time? Answer on page 7.
How do I record a TV program? Answer on page 10.
&c.
--
Elliott C. "Eeyore" Evans eeyore+ -at- cmu -dot- edu
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by an
anonymous satisfied subscriber since 1994.
---
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.
