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 (summarry) From:"Chuck Martin" <twriter -at- sonic -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 3 Jan 2001 09:56:43 -0800
Thanks to all that replied, both on the list and in person.
There seemed to be a split. Sort of paralleled my thinking. But 2 points
gave me some direction. One was that a FAQ tends to be (or perhaps should be
anyway) a "living" document, updated when needed to reflect current issues.
Harder to do in print, even if the "printed" document is only .PDF.
Also, it was suggested a short list of common questions, with pointers in
the book for answers. Kind of like what some tech support would do: "How to
set the time on your VCR? Welll on page 7 in your manual, is says to...."
THis morning, the feedback from on high was that there will be no FAG in the
User Guide. I think this is a good decision because I agree with several
people who pointed out that the information should be in the UG and well
indexed.
Thanks for the help. Y'all are great.
--
--
"[Programmers] cannot successfully be asked to design for users
because...inevitably, they will make judgments based on the
difficulty of coding and not on the user's real needs."
- Alan Cooper
"About Face: The Essentials of User Interface Design"
Chuck Martin
twriter "at" sonic "dot" net www.writeforyou.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
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.
