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: FAQs - Good or bad? From:"Robyn Richards" <robynrrr -at- hotmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 16 May 2005 00:51:21 +0000
My 2 cents on FAQs based on recent experience:
- In developing new documentation for a product which was already in
widespread use, I asked Support for 'frequently asked questions' to ensure I
covered that information in the user guide. I recieved only two responses
(which, given that Support were said to be 'inundated' with calls, I cannot
believe covered all the difficulties users were having with the product).
- When responding to Marketing's request for FAQ to be put on the web site,
the material required wasn't 'traditional' FAQ's, but rather Marketing FAQs
- a restatement of what the product would do for the client, in small
'sound-bite-sized' pieces.
- In my documents, I prefer to use a TOC and comprehensive Index to enable
users to find the information they need. I DO occassionally use FAQs - for
situations that a) are really 'frequently asked questions', b) cannot be
easily located in the main text (i.e. where the information is scattered
over several sections), c) where the situation occurs in very specific
circumstances and applies to only a small subset of users, or d) the
situation occurs because of the current state of the product and will change
in the next version.
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.