Re: orientation in description

Subject: Re: orientation in description
From: cjcbrown -at- comcast -dot- net
To: Kevin McLauchlan <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
Date: Mon, 21 Jun 2010 16:30:00 +0000 (UTC)



When we documented equipment in a standard rack in a server room, we always had to include where the reader was facing.

Otherwise there was room for confusion. Our equipment had interesting things on both panels, some of which had unique names, and it seemed the readers were often facing the front when needing to be facing the back, and vice versa.



We also had to have one-kernel sentences. (subject, verb, object). People did not read complex sentences well.

E.g., "In normal operation, each power supply shows a green LED for proper function. "

"The LED is on the rear panel in the upper right corner as you're facing the rear panel."



Don't know about there being a "default understanding" of a the person looking at it straight ahead.

Makes sense, though, maybe that's why they had to make up "stage right" and "stage left".



Connie


----- Original Message -----
From: "Kevin McLauchlan" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Monday, June 21, 2010 9:10:02 AM GMT -08:00 US/Canada Pacific
Subject: orientation in description

All,

We sell an encryption appliance that is meant to live in a standard equipment rack in a server room.

In the maintenance section, I had this sentence, which must have seemed ok when I originally wrote it, but which now seems fishy.

"In normal operation , each power supply (back panel right corner, as you face the rear of the appliance) shows a green LED, indicating proper function."


I'm sure it can be critiqued for other reasons (go ahead...) but I'm interested in how best to refer to the orientation and location of parts on a piece of equipment.

Is it "standard" to locate stuff (like rooms and features of a house, or parts of an appliance) by referring to the overall item (equipment, building, etc.) as though the reader is facing it front on? ÂOr should it matter, as long as you specify the point-of-view in the current situation?

In this case, I'm referring to basically exterior orientation and location. This is not the kind of huge and/or intricate equipment where you need a 3D co-ordinate system to guide a mechanic/tech into the bowels of the beast. Just a couple of power supplies and a trio of fans that are externally accessible and are hot-swappable. Â And loud... Â Â Â:-)

Anyway, my current deadlines are not frantically critical, so apparently I'm allowing myself the luxury of second-guessing myself.

Thanks,


Kevin McLauchlan
Senior Technical Writer
SafeNet, Inc.
--

The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.


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

Gain access to everything you need to create and publish documentation,
manuals, and other information through multiple channels. Choose
authoring (and import) as well as virtually any output you may need.
http://www.doctohelp.com/

---
You are currently subscribed to TECHWR-L as cjcbrown -at- comcast -dot- net -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/cjcbrown%40comcast.net


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

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

Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days.
http://www.doctohelp.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


References:
orientation in description: From: McLauchlan, Kevin

Previous by Author: Re: Need a term
Next by Author: Re: Editing scientific papers
Previous by Thread: RE: orientation in description
Next by Thread: RE: orientation in description


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

Sponsored Ads


Sponsored Ads