Nuance
Andrew Plato
"Ehr, Meg" wrote.
| And the only one who called Andrew any names was... Andrew, in his
original
| post -- "Now, all in unison: Andrew is a moron! :-)"
|
| I really don't understand why Tracy's post got so many people so riled
up.
| Compared to many posts I've seen on the list, it was nothing.
There is a big difference between me saying "I am a moron" and you saying
"Yeah, you're a moron." As masters of the communicative arts we should all
know that difference.
I am not mad at Tracy or anybody. My skin is thicker than that. I know she
was just trying to be cute and funny. And I did smile at her post.
Nevertheless, insulting somebody while they are trying to explain a
mistake comes off as a bit rude. If you did this to an SME at your job,
you would quickly earn that SME's disrespect and might wind up with your
hand out at the unemployment office.
And as I have said many times. It is one thing to criticize a person's
ideas or behaviors. It is another thing to criticize the actual person. I
will concede fully that I have come close to crossing the line many times.
I have also gotten my hand slapped by Eric and others. I have also worked
very hard over the past few years to word my posts such that I focus on
the issue and not the author. I wish my colleagues in this community would
make the same effort.
Which leads us to a lesson, as writers we all should know how to express
nuance. Its the hardest aspect of writing. But when it comes to technical
writing, the ability to accurately describe nuances in concepts is vital.
This whole little bungle is a prime example. There is nothing really WRONG
with me saying "get and IDS here are three." Its just that it wasn't
totally accurate. Some of those products really are not IDS's. There is a
nuance there, one that companies like ISS have gone to great lengths to
make part of their product.
We often complain how people don't notice the "little things" in our work.
Well to people who take content seriously, this is one of those "little
things." Expressing an idea in the most correct and accurate manner is
not as simple as copy-pasting an email from the engineer and then spending
the rest of the afternoon deciding whether you like Garamond or Times
fonts.
This is ultimately why a lot of technical documentation is useless. It may
be generally technically correct and look great, but since the writer did
not fully understand the technology, they did not have a handle on the
nuances of the products. The engineers that review the material, often do
so in a vacuum. If the material is basically correct, they'll sign off and
be done with it. But that doesn't mean the document is ACCURATE. I
routinely clarify and correct information given to me from SMEs. That is,
after all - MY FRICKIN' JOB!
Last night, I read this syrupy "What is a Technical Writer" paper from
some tech writing company (no I won't name names). It was rather funny. It
started out with an explanation about how its the tech writer's job to
clarify, refine, and organize complex information. (Sounds good).
The paper then spent the next 10 pages explaining this company's
experience and expertise at using FrameMaker and their trademarked
information mapping techniques. (uhhhh, what happened to the clarification
stuff?)
A perfect example where good intentions met bad implementation. I realize
the authors of this doc meant to explain how they are masters of using
said tools and techniques. But like so many other writers, they totally
missed the entire reason for their existence...that stuff about clarifying
information.
When you hire a college professor, do you pick the one that has the most
experience in his/her area? Or do you pick the one who can write the
neatest on the white board?
I realize there is a lot of newbie tech writers on this board who want to
know "what do I do to succeed in this industry." Well, today's events
illustrate how you can get ahead:
Analyze information, don't be a nitpicker. Understand what you are talking
about and be able to explain its many facets. The tech writers who make
the BIG money are not FrameMaker gurus (although many know Frame very
well), they are good communicators who are able to condense, digest, and
explain complex ideas with clarity, grace, and most of all - nuance. These
are people who companies are begging them to work for them.
They also know when to point that high-powered analysis back at themselves
and admit: I am a moron.
Andrew Plato
__________________________________________________
Do You Yahoo!?
Send your FREE holiday greetings online!
http://greetings.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ej...@raycomm.com) for details and availability.
---
You are currently subscribed to techwr-l as: tech...@GTS.ORG
To unsubscribe send a blank email to leave-tech...@lists.raycomm.com
Send administrative questions to ej...@raycomm.com. Visit
http://www.raycomm.com/techwhirl/ for more resources and info.
Sean O'Donoghue-Hayes (EAA)
Well good to see we are all back on an even keel now.....and other than
Andrew himself no response to my mythical user email - I would have thought
that was warranting of more attention than Tracy's well weighed and keenly
edged piece of literature - hell I even threw in a bit of corporal
punishment in there - where are the bleeding heart liberals when you rattle
their cage!!! Andrew gets them biting every time he throws a hook in the
water - must be the bait I use, I guess....
Tracy's article didn't necessarily come across well to people who don't know
technical writers - but I suspect ALL of us have at one time or another been
in that position of suddenly being showered in the golden light of
revelation - almost poetical - except when it seems it always occurs just
after you have delivered the documentation as occurred with Andrew and some
one says..."wouldn't it have been good if" or "well of course it ALSO works
that way" or "yes your completely correct except for....".
Reminds one of those dreaded management interviews where they begin "First
of all I would like to say you are doing an excellent job, but....."
now to much deeper problems - I note that Andrew has twice used the
expression "I am a moron" in emails. This is getting very seriously, I
suggest that we re-animate his depleted ego - which is obviously suffering -
I mean if he says something three times by his own high code of honour and
conduct it must be done!!! So Everyone - all of you out-there when you get
this email clap your hands once, and say, just loud enough so the developer
in the next cubicle thinks you loosing it, "Andrew is a fine human
being"....and imagine that you are giving him a big supportative hug!!! At
the very least Andrew should be bathed in a warm glow...at best we may
manage to crease his high-powered, wide shouldered, Armani suit. Within a
few moments of this I am sure Andrew will regain his composure, accuse us
all of being bleeeeeeeeding heart liberal communists who wish to bring down
free trade with our wimpy half-efforted unfocused humanistic ambitions -
and shall order the security guards of his being to cast us and our sloppy
support from his being,... and he shall once more become the man of steel
with the exacting chainsaw of truth regarding commercial realities that we
know him for. (god did I just end that in the word "for" - if it was golf
that would be fine - someone else can complain about that, and then fix it
up!).
And to Tracy - I must say a few words, despite the vocal textual support for
this lady we must do as we have always done with intelligent witty self
assured woman - I will be leading the march to the post, the faggots of wood
have already been placed around the post - once she is chained there we can
have a good satisfying witch burning - bring marshmallows it's a true
community get together.....oh and as the friendly neighbour organising this
I believe I get rewarded by the authorities with her possessions - so I'll
take her office chair, the stapler, and the white-out (even if it does make
a mess of pc screens).
Now back to work all you slackers, give your employer the sweat from your
brow, the blood from your heart, the tears from your eyes - and stop even
thinking about union-ising, else we have the boyos round later with the
baseball bats (we all going to baseball training officer, we big baseball
fans...) to discuss the finer point of union rhetoric and industrialism and
post communism capitalism....
regards and thanks,
Sean O'Donoghue-Hayes
"the guy wearing the t-shirt with the arrow saying "I'm with stupid"...who
hasn't realised yet that he is standing in front of a mirror...."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.
Andrew Plato
Mmmmmkay? Thaaaaanks.
Bill Lumberg
--- "Sean O'Donoghue-Hayes (EAA)" <Sean.O'Donoghu...@ericsson.com.au>
wrote:
| right prepare for a joyous rant - Hallelujah....
|
__________________________________________________
Do You Yahoo!?
Send your FREE holiday greetings online!
http://greetings.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ej...@raycomm.com) for details and availability.
---
Wade Courtney
I have a nearly 300 page user guide that I have been banging my head against
for quite some time. I have been trying to figure out what was wrong with
it, what was missing. That one little word gave me the answer.
That's why I love this list.
Wade