Placement of Question and Answer Sections in a User Guide

Subject: Placement of Question and Answer Sections in a User Guide
From: "Douglas S. Bailey (AL)" <dbailey -at- commandalkon -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 20 Mar 2002 11:51:25 -0600

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?

I'm trying to help the user avoid having to think, since that generally is
how they prefer to operate. (No offense intended.) IMO when a user decides
he needs help with something, he generally has a question he wants answered.
I think it might be easer for the user to find the Q&A section if it's right
up front. Of course, the answers will refer the user to the appropriate
sections deeper in the user guide for more information.

Is there a glaring flaw in my strategy that I'm overlooking?

--Doug



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.



Follow-Ups:

References:
Layout for hard-copy documents: From: Victoria Whitehorne

Previous by Author: Re: Ban the Semicolon?
Next by Author: Re: Techwr-l : The Movie <OT - humor>
Previous by Thread: Re: Layout for hard-copy documents
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