Re: Sanity check

Subject: Re: Sanity check
From: Tiffany Crotogino Munoz <Crotogino-Munoz_Tiffany/CORP_LABS -at- CST -dot- CA>
Date: Mon, 26 Aug 1996 14:42:43 -0400

> BUT (excuse me for shouting) it seems to me
that important
> secondary purposes include things such
comforting,
> encouraging; convincing the user that the
software
> developer, the software, and the user are all
members on a
> highly successful team.

> To what extent do you consider this true?

I certainly agree that the on-line help I write
for our product is intended to do more than
inform/instruct. Part of the on-line help's
"raison d'etre" is to reassure the user that the
company producing the software is sufficiently
interested in the user to provide them with
effective assistance when using the product.
The help files I write are often the user's main
source of instruction (not all of our users have
the manual available to them at all times).

>And (if you think
> this is true) what rhetorical tools to you
apply and to what
> extent do you apply them?

Most of this is achieved through tone and
straightforward writing. I write friendly, not
authoritarian help files. They're *not* chatty,
however. And I try to make sure that the text is
clear, clear, clear. If they can understand it,
they'll feel much better about the situation.
After all, if you can't understand the help
file, you must *really* be lost!

FWIW,


Tiffany Crotogino Munoz
Technical Writer
CS&T
Montreal, QC Canada
tiffany -at- cst -dot- ca


My opinions are mine, not the company's. If they
want to share them, that's fine. If they don't,
that's fine, too.

TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-



Previous by Author: Is It My Job?
Next by Author: Re: What's This? help -- Is it required?
Previous by Thread: Re: Sanity check
Next by Thread: Re: Sanity check


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

Sponsored Ads


Sponsored Ads