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 - what do you think of them? From:Eric Haddock <eric -at- ENGAGENET -dot- COM> Date:Thu, 7 Nov 1996 07:39:09 -0600
>Should we as technical writers support or discourage this type of
documentation?
Like all documentation types and writing styles, there is a place for it.
FAQs are pretty much informal information dumps (kind of) and serve really
one purpose: stave off calls to customer service.
FAQs are marvelous for compiling information that needs to go in to the
next revision of a manual. They can be excellent tools. More accurately, the
method of compiling a FAQ serves a regular manual excellently. If you have
enough for a FAQ then you have enough to revise a manual.
For in-house purposes, a FAQ can be great because since there's no
introduction to a FAQ usually, the in-house person doesn't have to read
material she doesn't have to and can get right to what to what she wants.
Very good if that person is servicing customers.
I wouldn't distribute a FAQ to the public however. I think they're too
informal and basically too slipshod to give a professional appearence, and
this appearence is important. Instead of a FAQ, I would opt for a
troubleshooting section where common errors and solutions are listed in a
professional manner.