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.
<<After step 2: They now have done all the thinking necessary to
understand the various options that will be introduced by the installer
software. >>
In my case this is my concern. If I hold there hand through the install and
tell them "Enter XXX here" then the hope is that they will correctly install
even if they don't understand it. In a network environment this could
require getting the customer up to speed about how networks work and how the
options will affect the installation of our product? If I knew all my
customers/users were familiar with networks then it would be a different
story.
In my case I just say:
1. Things you need to know before installing
2. Things you need to do before running the installer
3. Select from the following install options and follow the instructions
To install for this situation, do this:
3a. Put away the manual and run the installer.
To install for this other situation, do this:
3b Run the installer and when you get to the XXX screen, enter this.
And I guess I'm arguing that in the case of 3b the user might become unsure
and insecure if the instructions don't account for all the screens whether
that be a window by window explanation or a "Follow the onscreen
instructions until you get to the XXX window".
So I agree with Geoff, but I think there are situations that validate a
different approach.
Brian Jennings
Documentation Specialist
Cougar Mountain Software
phone: (208) 375-4455 email: BrianJennings -at- cougarmtn -dot- 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.
