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: Tue, 25 May 2004 11:19:03 -0400


Jay...this is good.

Everyone else..before you think..yeah, but my readers are much more
technical so I don't have to write to the same detail...you don't know
that unless you do a study of your specific users and know exactly what
they are...don't assume that because the product is technical, that the
users "must" be as technical.

I think assuming things about our readers that we don't know for certain
is one of our biggest obstacles to producing quality stuff.

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

-----Original Message-----
Subject: Documenting installers?


Before my previous gig, I balked at the idea of documenting installers.
My previous client decreed it, however, and the first few times out we
did the bare minimum and the focus was on the technical requirements.
Help Desk calls soared. By the time I left that job, the install manual
was so detailed that it included a screenshot of every single step, with
a circle around the button to click. The audience was civilian employees
of a US gov't department. Many of them had scant

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

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: THANK YOU BILL ! re: crappy screenshots
Next by Author: RE: Word vs. Frame
Previous by Thread: Documenting installers?
Next by Thread: RE: Documenting installers?


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


Sponsored Ads