Docs review and respect?

Subject: Docs review and respect?
From: "Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 11 Dec 2000 08:47:43 -0500

Cayenne Woods reports that: <<Mainly I got that it's fairly standard to
attach some sort of guidelines to send to people who are reviewing
documentation.>>

Agreed, but with one caveat: Standard this may be, but effective it often is
not. I've found over the years that attached guidelines usually get glanced
at then ignored, either because "I know how to do reviews, so don't insult
my intelligence by telling me how" or "it's not part of the manual they sent
me to review, so I'll ignore it and hope it goes away". One thing I always
advocate--and periodically have to remind myself to do--is to actually talk
to the reviewers and explain what I want done. This takes a bit longer, but
the payback is almost always worthwhile. I say "almost" because a few of my
reviewers really did prefer written instructions: different strokes for
different folks.

<<I think there's a big difference between a writer and a secretary, and I'm
not sure some people here really get that.>>

Yup, and it's an ongoing problem; one researcher I worked with had no
respect for me whatsoever until he discovered I'd won a scholarship in our
mutual field of research. But for most people, personal contact helps erode
that perception: once they begin seeing you as a person, and begin
discussing issues with you often enough to see that you have a mind and that
you know what you're doing, they'll start treating you as a person with a
mind. Secretaries commonly fall into the same trap because they become part
of the office furniture rather than someone who can talk to you knowledgably
and thus be seen as a person.

<<About respect and this forum - I'd find it more useful if we could all
assume each other has a clue, and start from there. Just a thought.>>

Ah, but having a clue isn't the same as knowing you have a clue, as Holmes
periodically chastises Watson: [paraphrase] "You observe, Watson, but you do
not see!" <g> Still, a modicum less "get a clue" would certainly improve the
level of discourse around here.

--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca

"Tarzan's rule of data processing: Never let go of one vine until you have a
solid hold of the next."--Anon.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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: Writing conceptual info. for single sourcing/online help?
Next by Author: Conference fees and new work?
Previous by Thread: docs review and respect
Next by Thread: RE: The Problem with the STC -- A Heretical Perspective


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


Sponsored Ads