Re: If you were making a FAQ...

Subject: Re: If you were making a FAQ...
From: kafkascampi <kafkascampi -at- gmail -dot- com>
To: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
Date: Thu, 30 Aug 2012 16:20:23 -0700

Kevin asked about FAQs in online help
I've added FAQs to my help system--I pulled them in from the Phantom Zone
limbo of support templates...went through the list of cases with Support
and pulled the popular topics for FAQs. And I ended up putting an FAQ book
in each section of the help, with single Questions as individual topics
beneath. When you click the book, you get a list of all the Questions in
that topic...and I have related links at the bottom of the each Question

My thought was to divert some of the load from support, and catch common
questions before users file support tickets. Most, if not all, the answers
to the questions could be found in existing help topics, but Questions are
more focused--sometimes addressing a very minor thing to which you wouldn't
devote a whole topic.

My primary deliverable is HTML5 from Flare, like you. So the new
Google-style search results work very well when a Question topic returns in
the list of results.

I salute you, my HTML5 brother. Perhaps you'd like to discuss the bizarre
wrapping behavior in the TOC in IE9?



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.


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @


If you were making a FAQ...: From: McLauchlan, Kevin

Previous by Author: Re: LaTeX and output to MS-Word
Next by Author: FrameMaker and DITA
Previous by Thread: RE: If you were making a FAQ...
Next by Thread: RE: If you were making a FAQ...

What this post helpful? Share it with friends and colleagues:

Sponsored Ads