RE: Documenting installers?

Subject: RE: Documenting installers?
From: "John Posada" <JPosada -at- isogon -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 20 May 2004 11:51:27 -0400


Bonnie...not to be a stickler and I'm not looking to ding your work (god
knows I might not stand up to examination), but this is the type of
issue I believe we should strive to avoid.

"...installed on the Server, you can choose
Yes or No for DHCP depending on how
your network is configured."

"Deselect the IPX/SPX checkbox unless
your network needs it."

At this point, I might be wondering "How IS my network configured or how
do I know if I need it?"

I once referred to personas. At my last job, I created one called
"Igor". Igor was a third-shift NOC operator who's been on the job for
one week and needs to be walked though the process of fixing a network
outage. These are the issues that might stump him.

OTOH, you might not be writing for him.

John Posada
Senior Technical Writer
Isogon Corporation
http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"


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

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.



Follow-Ups:

Previous by Author: RE: Documenting installers?
Next by Author: RE: Documenting installers
Previous by Thread: Re: Documenting installers?
Next by Thread: Re: Documenting installers?


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


Sponsored Ads