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: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
topic.
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?
:)
Chris
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.