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 in User Guides From:"Elliott C. Evans" <eeyore+ -at- cmu -dot- edu> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 03 Jan 2001 10:26:59 -0500
Chuck Martin wrote:
> > Perhaps, if you know that certain sections of the manual answer questions
> > that are more frequently asked, a second "index" would be helpful. It
> > should probably be shorter than a full page, and simply contain FAQs and
> > page references.
> Of course, all this is predicated on the assumption that users will actually
> open the User Guide (even an electronic version). :)
If it's a printed manual, you could always print the FAQs on the cover. =^>
A quick survey of the manuals on my shelf reveals a serious dearth of back
cover material. Until Kirkus begins reviewing manuals, an FAQ list seems
like a useful way to occupy this real estate.
Elliott C. "Eeyore" Evans eeyore+ -at- cmu -dot- edu
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.