Re: Documenting installers?

Subject: Re: Documenting installers?
From: "Bonnie Granat" <bgranat -at- granatedit -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 20 May 2004 12:45:33 -0400


Brian Jennings wrote:
> <<So your installation instructions can be as follows:
> 1. Things you need to know or do before installing
> 2. Options to think about before you run the installer.
> 3. Put away the manual and run the installer.>>
>
> In principle I completely agree. However, in my case I am
documenting
> an
> install of a product that can be networked and while this scenerio
> works
> perfectly for that, it does not work as well for the network
> installation.
>
> Still, even on the network install I only need to include
> instructions on
> parts of the process but it seems that once I comment on any part of
> the
> install process the user then gets antsy and insecure if other parts
> are not
> documented. Maybe it's a matter of trust. If I must provide external
> documentation on any part of the install, then the user must wonder
> about
> the rest. I.e. if they can't trust what they see on the screen for
> everything they need to know in one section of the install, how can
> they
> trust the rest. It seems an assurance issue more than anything.
>

If you use numbered procedures, you can say something like the
following (adapted to your purposes, of course):

5. Click Configure Blipple. Follow the instructions for configuring
the blipple that appear on each screen. When prompted, click Finish
and go to Step 6.


Bonnie Granat
www.granatedit.com





^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo

>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more.
http://www.doctohelp.com

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.



References:
RE: Documenting installers?: From: Brian Jennings

Previous by Author: Re: Documenting installers?
Next by Author: Am I a spammer?
Previous by Thread: RE: Documenting installers?
Next by Thread: Documenting installers? (Take II)


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


Sponsored Ads