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: If you were making a FAQ... From:Damien Braniff <Damien -dot- Braniff -at- asg -dot- com> To:"McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>, "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 31 Aug 2012 08:05:03 +0100
a) Would you include it in online help (WebHelp) if that was the primary documentation for your product?
Yes and No! :-) I'd be tempted to do it as a separate, linked, Help file. If it's currently only 1 of 2000 odd topics it would be easier to maintain with no need to regenerate the 'big' help each time you updated it.
b) If yes, then would you make it one big FAQ topic/page, or would you make each Q and A a separate topic/page under a FAQ "book" in the ToC?
Why?
Depending on the size etc you can do it as separate topics with toc etc while still making it easy to print if required
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
