RE: Perceptually true, Technically wrong, Pedantically Geeky?

Subject: RE: Perceptually true, Technically wrong, Pedantically Geeky?
From: Kim Roper <kim -dot- roper -at- pixelink -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 10 Mar 2003 13:32:27 -0500


Paul DuBois noted:
>
> I tend to agree. It's such reasoning that leads to things like:
>
> Move the mouse to postion the cursor on the screen over the image of
> the button containing the word "okay", then click the mouse button to
> send a signal to the computer to perform the action logically
> associated
> with the button image.
>
> Rather than:
>
> Use the mouse to click the "okay" button.
>
> The latter is less technically accurate, but corresponds more to how
> people think and act.

The latter instruction is accurate enough for the intended audience. The
extra precision of the former instruction isn't adding any value in this
case.

> Having said that, there probably are audiences when the
> former approach is betters.

>From Kim's Rules of Technical Writing:
Rule #1--Know your audience.

>From Kim's Useful Acronyms of Technical Writing:
TMI--Too Much Information

One of the challenges of technical writing is in knowing when to *stop*
adding information. I was told by one of my instructors that this is the
bane of "technical" technical writers (such as me :).

This kind of judgement call is exactly the kind of thing we're paid to do.

Cheers ... Kim
kim.roper at pixelink.com
http://www.pixelink.com/

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

Order RoboHelp Office X3 by March 14 and receive a $100 mail-in rebate,
plus FREE WebHelp Merge Module and FREE iMarkup Software, for a
total giveaway value of $439! Order today at http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

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



Previous by Author: RE: Am I qualified to be a Technical Writer
Next by Author: RE: Need a smarter person than me
Previous by Thread: RE: Perceptually true, Technically wrong, Pedantically Geeky?
Next by Thread: RE: Perceptually true, Technically wrong


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


Sponsored Ads