RE: Survey Question

Subject: RE: Survey Question
From: "Joe Malin" <jmalin -at- tuvox -dot- com>
To: "Diana Ost" <Diana -dot- Ost -at- msmcorp -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 26 Jul 2006 11:40:45 -0700

It's never happened to me. In fact, they have always expected me to
learn the software and use it before I even ask questions.

You should tell them that your documentation will be incomplete because
you have no way of describing the UI or any of the procedures for using
the software. They may say, "well, we'll give you the instructions we
wrote ourselves." You say "OK, we'll trade. You get to review *my*
documentation, and I get to review *yours*".

Just kidding.

I am curious, though. How do they expect you to describe the UI if you
can't see it? And if they don't want you to describe the UI, what the
heck do they want you to *write*?

I can just see this: the manager goes off and tells his or her engineers
to write down all the instructions for using the software and then give
them to you, thus wasting their time and coming up with less useful


Joe Malin
Technical Writer
jmalin -at- tuvox -dot- com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.

-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Diana Ost
Sent: Wednesday, July 26, 2006 10:31 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Survey Question

I have a question for the group:

How many of you have been asked to document a software application, but
were not expected to need access to that software?

It's happened to me a few times where I had to explain that I can't
document what I can't see. I was wondering how prevalent this attitude
is from businesses?


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!

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at

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

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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Getting rid of the manual
Next by Author: RE: Career change to tech writing
Previous by Thread: RE: Survey Question
Next by Thread: RE: Survey Question

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

Sponsored Ads