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:Debbie Hemstreet <D_Hemstreet -at- rambam -dot- health -dot- gov -dot- il> 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:Sun, 2 Sep 2012 05:37:43 +0000
People don't like to click and look.
I'd have it in the Help, or possibly if you have a SW app, an additional option in the Help menu.
I'd use drop-down text, and have everything on one page, perhaps categorized so the reader can quickly locate the problem area and then look at the items for that topic area.
Drop-down text lets you have everything in an organized manner on a page, but it is navigateable.
Deborah
-----Original Message-----
From: techwr-l-bounces+d_hemstreet=rambam -dot- health -dot- gov -dot- il -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+d_hemstreet=rambam -dot- health -dot- gov -dot- il -at- lists -dot- techwr-l -dot- com] On Behalf Of McLauchlan, Kevin
Sent: Thursday, 30 August, 2012 23:03 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: If you were making a FAQ...
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?
Why?
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
************************************************************************************
This footnote confirms that this email message has been scanned by PineApp Mail-SeCure for the presence of malicious code, vandals & computer viruses.
************************************************************************************
************************************************************************************
This footnote confirms that this email message has been scanned by
PineApp Mail-SeCure for the presence of malicious code, vandals & computer viruses.
************************************************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
