Re: Do we need to document all UI elements?

Subject: Re: Do we need to document all UI elements?
From: "Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>
To: mallikarjuna999 -at- yahoo -dot- co -dot- in
Date: Thu, 26 Jun 2008 11:28:24 +0300

Best technical writing answer is:
it depends!
This question has come up a few times, I suggest searching the archives.
Apart from that, you have to ask.
What sort of document are you writing and who is your audience.

In general, you should provide the user with the amount of information that
they need in order to get the job done.
So you should ask.
Who is this book for?
What do they want to do with the software?
What information do I need to provide so they can do this.

On 6/25/08, mallikarjuna prasad <mallikarjuna999 -at- yahoo -dot- co -dot- in> wrote:
> Hi,
> Do we need to document all UI elements?
> Cheers
> --
> Caroline Tabach
> Technical Writer
> e-mail: caroline -dot- tabach -at- gmail -dot- com

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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 admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Do we need to document all UI elements?: From: mallikarjuna prasad

Previous by Author: Re: Page break as local formatting permitted?
Next by Author: Re: Multiple instances of Word
Previous by Thread: RE: Do we need to document all UI elements?
Next by Thread: Re: Do we need to document all UI elements?

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

Sponsored Ads