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.



Previous by Author: RE: Techwr-l : The Movie <OT - humor>
Next by Author: Re: page orientation problem when printing from pdf
Previous by Thread: Re: Master Documents, with a side of Single Source Sauce
Next by Thread: Re: Placement of Question and Answer Sections in a User Guide


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads