RE: Task-based vs. descriptive online help? (quasi-summary)

Subject: RE: Task-based vs. descriptive online help? (quasi-summary)
From: "Michele Marques" <marquesm -at- autros -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 8 Mar 2001 15:44:52 -0500

edunn -at- transport -dot- bombardier -dot- com writes:
> But is the NAME field such a bad example? All I see is an example
> of bad help
> writing. The NAME of what? My name, the clients name, the
> application name, or
> maybe something else?

I would further add, that the help for this field doesn't just have to say
something document on-screen (e.g., enter the client's name), but can also
state restrictions about the field (e.g., The name field is restricted to 25
alphanumeric characters and may not include accented characters.) and
whether the field is mandatory or optional.

Michele Marques
Technical Writer,
Autros Healthcare Solutions
marquesm -at- autros -dot- com

This material is intended for the use of the individual to whom it is
addressed and may contain information that is privileged, proprietary,
confidential and exempt from disclosure. If you are not the intended
recipient or the person responsible for delivering the material to the
intended recipient, you are notified that dissemination, distribution or
copying of this communication is strictly prohibited. If you have received
this communication in error, please contact the sender immediately via
e-mail and destroy this message accordingly.


Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30) or 800-646-9989.

IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.

You are currently subscribed to techwr-l as: archive -at- raycomm -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 for more resources and info.

Previous by Author: RE: Advocating Documentation and Support
Next by Author: RE: laid off
Previous by Thread: RE: Task-based vs. descriptive online help? (quasi-summary)
Next by Thread: Re: Writing Tools

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

Sponsored Ads