TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:RE: Thank You from new tech writer From:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 6 Mar 2008 09:27:35 -0800
In many organizations, technical writers are paid less than
developers--even thought the technical writing skill set is not
off-shoreable and, arguably, in shorter supply than development skills.
Every now and then, I even see an advertisement on Craigslist in which
someone wants to hire a "technical writer" for $13.50 an hour. Can you
imagine anyone posting a similar add for a developer? Who's to blame for
this? Technical writers themselves. Technical writers often accept
substandard salaries and fail to recognize their contribution to IT. We
often regard ourselves and lead others to treat us as second class
citizens.
I agree with Kevin, and his comments make me wonder ...
... are developers _expected_ to send thank you notes or
acknowledgements to QA?
... are product managers _expected_ to say, "I couldn't have gotten this
done without the help of X, Y, and Z"?
... who else is _expected_ to express thanks to others who are merely
doing what is part of their job description?
Acknowledging others is generally a good idea, and I think we have to be
careful never to give the impression that someone has done us a
favor--unless they really have done us a favor. If a SME is tasked with
working with me to produce docs, he or she is not doing me a favor by
working with me to produce docs.
The problem with giving the impression that X, Y, or Z has done us a
favor (when they are merely doing their job) is that it implicitly
reduces technical writers to proverbial unwanted bastard children:
"Thank you so much for lifting your feet so I can scrub the floor
beneath you with my tooth brush." And that is by no means what we are.
Good tech docs are essential for the success of any sophisticated
technical product. Poor tech docs give a bad impression of a product,
disappoint users, and fail to mitigate calls to the help desk.
I don't think Kevin was in any way devaluing technical writing or
suggesting we become groveling sycophants. I like his suggestion of
including acknowledgements. And, while being mindful of the fact that we
are just one small part of the big IT picture, we must never
underestimate the value of that small part or send the impression that
we are thankful for being tolerated.
Leonard C. Porrello
SoleraTec LLC
www.soleratec.com
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of McLauchlan, Kevin
Sent: Thursday, March 06, 2008 8:33 AM
To: Jim Mezzanotte; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Thank You from new tech writer
Here's another thing to put in a tickle-file or calendar reminder that
will pop up for you every once in a while:
Give credit.
It's nice that you sent us a thank-you. It makes us all warm and tingly.
Now, when you have created some docs that people actually use, you
probably will have several persons _inside your company_ to thank for
various kinds of assistance at acquiring information, figuring out the
best way(s) to present it, and (especially?) verifying that it's correct
and useful. There might even be a volunteer hand-model if you were
taking photos to illustrate techniques and safety issues.
I suggest two things.
If your docs will be confined to the company premises - viewed and used
by people who work for the same company - then consider including an
acknowledgements section in which you name names.
If the docs might go outside the company - say, for end-users of your
products (where the company probably doesn't want to publish individual
identifying information), then post a thank-you note on the company
bulletin board or in-house website or wherever employees will see it,
expressing appreciation for the helpful and knowledgeable assistance of
whoever was... well... helpful and knowledgeable on your behalf while
you were compiling the wonderful docs that everybody is now
using/referring to.
This will encourage others, the next time you need to create or update
some material. It will also be of real benefit to some (if not all)
co-workers who are singled out in writing (see below).
If your company is "not that kind of place", then send private e-mails,
commending each deserving person to their immediate supervisor(s) and to
at least one manager higher up the chain (include a CC to Human
Resources). This will likely go into the employee's file and will
likely help her/him at her/his next evaluation. If the shop is
unionized, the written accolades in the personnel file will not be of
immediate help, but will help in future when that person tries out for a
non-union staff job. Don't gush, of course, but indicate briefly if the
person saved time and effort, helped locate and correct errors and
omissions, or otherwise contributed useful assistance.
In that kind of situation, I prefer to not send a copy to the person
being lauded. That could be embarrassing and could look like sucking up.
Better that they should have a pleasant surprise at their next employee
evaluation when the supervisor trots out the letter/e-mail from you and
gives the employee a higher evaluation - it's also useful ammunition for
a supervisor who wants to see an employee get a bonus or better
pay-increase, and needs some third-party validation for that submission.
There's an extra little frisson when the supervisor, in turn, discovers
that her/his own evaluation is bolstered by a glowing letter about the
supervisor that was sent to his/her manager.
Obviously, don't over-do. Well-considered written praise of cow-orkers
is valuable. Making an every-day habit of it will devalue it.
Kevin
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.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
