Re: Survey Question

Subject: Re: Survey Question
From: Sean Wheller <sean -at- inwords -dot- co -dot- za>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 26 Jul 2006 20:03:11 +0200

On Wednesday 26 July 2006 19:31, Diana Ost wrote:
> 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?

It can happen. Best when it does is to get even closer to the software
architect and do the job of writing the software specs, etc. If you can, get
access to the code. This will give you a good understanding of the
functionality. From this stage you can start to get an understanding of what
the interface of application layer will do. You may not be able to write the
user manual to the fullest extent as the interface design often changes
during development, but you will be able do the structuring, concepts and
some of the feature or functional descriptions.

In some cases where you cannot get access to source code, the work can be done
totally in the blind if you have a very patient and communicative team.
Ask me about the Monkey.

Sean Wheller
Technical Author
sean -at- inwords -dot- co -dot- za

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.

Survey Question: From: Diana Ost

Previous by Author: Re: Freelancing Technical Writing
Next by Author: Re: Survey Question
Previous by Thread: Re: Survey Question
Next by Thread: Re: Survey Question

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

Sponsored Ads