Re: Do we need to document all UI elements?

["Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>]

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?
Then
What do they want to do with the software?
Then
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.
http://www.DocToHelp.com/TechwrlList

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

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.