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:"Richard Smith" <Richard -dot- Smith -at- windriver -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 2 Jan 2001 16:09:03 -0800
<Should a FAQ page be a part of a User Guide?...The current online Help
system had a FAQ page, which is a common convention for web-based user
I say your thinking is correct. Don't include it! A FAQ is a support tool
that evolves as the Frequently asked questions do. A useful FAQ is usually
not a one time shot, rather a document that requires maintenance as issues
Then things that are on your current or previous FAQ can be incorporated as
UI or doc changes in the next release/revision.
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.