Re: Appropriate -- so inappropriate!

Subject: Re: Appropriate -- so inappropriate!
From: Michael West <WestM -at- ap -dot- aurecongroup -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 13 Jul 2009 16:37:40 +1000

> From: "Gene Kim-Eng" <techwr -at- genek -dot- com>

> I think it is exactly an issue of reading comprehension.
> In a lowest common denominator environment, if you say
> "choose the colors for your screen," I would bet real
> money that someone will ask "how do I know which colors
> I should choose?"

And you'd win the bet because "Choose the colors for your screen" is not a
clear instruction, although it is certainly possible to argue that it is
"clear enough" for a given audience in a given situation.

It isn't clear because it doesn't specify the relation between choosing
and the outcome.

Another common variant is "Choose the colors that your screen will be."
Huh? I'm supposed to predict? Do I get a clue? What do I win if I guess
correctly?

It's weak syntax. Technical writers are supposed to know better. Clear
writing isn't just about being understood. It's about removing any
possiblilty of being misunderstood.

Regarding the original post -- yes, "appropriate" is an empty filler that
should be avoided unless accompanied by a reference or hyperlink to
specific criteria the user can apply to determine what is or is not
appropriate.

"Relevant" is another one, as in "Choose the relevant account type".
"Appropriate" and "relevant" are earmarks of writing done by people who
think it's important to sound "technical" irrespective of making sense.
And so is blaming any misunderstandings upon our readers' "stupidity"
rather than our own ambiguous syntax.
--
Mike







Disclaimer - http://www.aurecongroup.com/apac/disclaimer/




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! 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.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Previous by Author: Re: PDFs as online help?
Next by Author: RE: baud vs. baud rate
Previous by Thread: RE: Appropriate -- so inappropriate!
Next by Thread: Am I Off the Wall?????


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

Sponsored Ads


Sponsored Ads