Re: Quick Start Guide

[Keith Hood <klhra -at- yahoo -dot- com>]

Cover, in this order...

  1)Warnings the user must know before use
  2)Prerequisite actions/things needed before using
  3)How to start it properly
    A)The MOST important/commonly-used functions
      *)For each, only the essential controls/features
      *)For each, the expected results
    B)How to save results
  4)How to safely shut it off

Step 3B assumes this is a software product, but it
could be valid in modified form in many products.

The *) steps may not have to to be separate steps -
that information could be woven into the actual
procedural steps, as long as you show the user what to
expect.

Use illustrations as much as possible and keep the
verbiage to an absolute minimum.   For example,
instead of writing "Click on the Start button," put in
a screen cap of the Start button with an arrow
pointing to it, and the words, "Click here."

Keep it as short as possible. Think in terms of a
tri-fold brochure for the amount of real estate you
can use.

And of course, exactly what points are covered may
change depending on your audience and the exact nature
of the thing you're documenting. What kind of product
is it? 




--- Deborah McNally <tig -dot- techwriter -at- gmail -dot- com> wrote:

> Hi, I usually just lurk around here, but I have a
> new project for
> which I need some suggestions.
> 
> Normally I write online help and printed manuals. 
> I've been asked for
> a 'Quick Start Guide' for one of our products.  Does
> anyone have a
> suggestion of where to start? I don't want to put
> *too much* into it,
> but I want to make sure that I hit all of the points
> that should be in
> a quick start.  Even a template would be helpful.
> 
> Thanks in advance for any and all help.
> 
> -- 
> Deb McNally
> Windmill International, Inc
> Technical Writer / Customer Support
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> WebWorks ePublisher Pro for Word features support
> for every major Help 
> format plus PDF, HTML and more. Flexible, precise,
> and efficient content 
> delivery. Try it today!
> http://www.webworks.com/techwr-l
> 
> Easily create HTML or Microsoft Word content and
> convert to any popular Help file format or printed
> documentation. Learn more at
> http://www.DocToHelp.com/TechwrlList
> 
> ---
> You are currently subscribed to TECHWR-L as
> klhra -at- yahoo -dot- com -dot- 
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>
http://lists.techwr-l.com/mailman/options/techwr-l/klhra%40yahoo.com
> 
> 
> To subscribe, send a blank email to
> techwr-l-join -at- lists -dot- techwr-l -dot- com
> 
> Send administrative questions to admin -at- techwr-l -dot- com -dot- 
> Visit
> http://www.techwr-l.com/techwhirl/ for more
> resources and info.
> 
> 


----------------

Keith Hood
Senior (only) tech writer
ACS, Inc.


 
____________________________________________________________________________________
Do you Yahoo!?
Everyone is raving about the all-new Yahoo! Mail beta.
http://new.mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help 
format plus PDF, HTML and more. Flexible, precise, and efficient content 
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.