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.
Re: Placement of Question and Answer Sections in a User Guide
Subject:Re: Placement of Question and Answer Sections in a User Guide From:"Mark L. Levinson" <nosnivel -at- netvision -dot- net -dot- il> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 21 Mar 2002 21:17:51 +0200
Douglas writes:
> Is there a glaring flaw in my strategy that I'm overlooking?
I suspect that if there is, the flaw is that your Q&A should
be done as help rather than printed. As Geoff remarks, the
Q&A has no natural sequence of its own and no natural place in
the sequence of the book. If the Q&A is accessed electronically,
then the user can be given a little menu hierarchy or keyword
search to lead to the correct material.
If some of the questions have to do with conditions
when the program isn't accessible, they can go
into the book as an appendix (at least they'll have
something in common) and get cross-referenced from an
appropriate place in the body of the book, if there is
such a place. ("This is how the main menu looks. If you
couldn't even get a main menu, see Appendix A.")
Kim writes:
> Doesn't anyone want to be portrayed by Linda Hamilton?
Hell, why not?
Mark L. Levinson
Herzlia, Israel
nosnivel -at- netvision -dot- net -dot- il
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
PC Magazine gives RoboHelp Office 2002 five stars - a perfect score!
"The ultimate developer's tool for designing help systems. A product
no professional help designer should be without." Check out RoboHelp at http://www.ehelp.com/techwr
---
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.
