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:"Dick Margulis " <margulis -at- mail -dot- fiam -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 20 Mar 2002 13:13:54 -0500
Doug,
How about in the frontmatter, with an eye-catching typographic treatment so the user sees it right away? Oversize, bold (maybe colored if you're printing in color) Qs and As; each answer is just a page reference:
Q: How do I select the right options for my frammis?
A: Page 67
And so forth.
Dick
"Douglas S. Bailey (AL)" <dbailey -at- commandalkon -dot- com>
wrote:
>I'm creating a software user guide, and am planning to include a list of
>commonly asked questions, though not necessarily as an official FAQ. Do you
>think it would make sense to include it at the front of the document,
>immediately after the (quite small) installation section? Or is the more
>traditional method (to include it at the back, perhaps as an Appendix)
>better?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
