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:Brathwaitec <brathwaitec -at- cacctus -dot- net> Date:Thu, 30 Aug 2012 16:30:59 -0400
Thanks. I'm currently using a single page, that has not yet reached what I would consider "very long" - a moving target, to be sure.
My cow-orker also favors this approach because otherwise each separate FAQ topic would have an H1 heading to start, which would make it a new chapter if/when we decided to generate a print/PDF version rather than the usual WebHelp/HTML5-help version.
But another opinion was that separate pages make more sense for scanning in a ToC (as long as the titles are descriptive), and are just as searchable as a giant one-pager.
I admit that while many of my Qs are A'd with a paragraph or two, many others are answered with ten or fifteen paragraphs - it takes what it takes... :-)
Not sure if that argues for one or the other option, or is a neutral factoid.
Other votes and cogent comments?
> -----Original Message-----
> From: Brathwaitec [mailto:brathwaitec -at- cacctus -dot- net]
> Sent: August-30-12 4:21 PM
> <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?
> All on one page.
> > Why?
> It is easier for the user to scan and print. Also sometimes the user
> knows what they want to ask but not how. Being able to easily see
> other similar questions and answers is helpful. I also think too much
> clicking is annoying for some people.
> That being said, if the FAQ is very long I will consider breaking it up
> into smaller chunks and placing those on separate pages. But it is
> often just as easy to organize a single page and add links to different
> sections near the top of the page.
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.