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:"McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com> To:Gene Kim-Eng <techwr -at- genek -dot- com> Date:Thu, 30 Aug 2012 16:58:15 -0400
The primary documentation for the product in question (one of many) is WebHelp/HTML-5 help totalling over 2000 topics.
Of that, ONE TOPIC is currently a FAQ.
Please be a little careful about that kind of remark, or insert a smiley or something, otherwise, somebody will take it as fact and repeat it, to my employer's detriment.
From: Gene Kim-Eng [mailto:techwr -at- genek -dot- com]
Sent: August-30-12 4:45 PM
To: McLauchlan, Kevin
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: If you were making a FAQ...
I would hope that any company whose primary product document was an FAQ would make it available pre-sale so I can find out that that's all the info I'm going to get in time to shop for an alternate product.
On Thu, Aug 30, 2012 at 1:03 PM, McLauchlan, Kevin <Kevin -dot- McLauchlan -at- safenet-inc -dot- com<mailto:Kevin -dot- McLauchlan -at- safenet-inc -dot- com>> wrote:
a) Would you include it in online help (WebHelp) if that was the primary documentation for your product?
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?
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.