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.
RE: Honestly -- when an SME completely REWRITES your text ... GEEZ!
Subject:RE: Honestly -- when an SME completely REWRITES your text ... GEEZ! From:"McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com> To:"Janice Gelb" <Janice -dot- Gelb -at- Sun -dot- COM>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 17 Oct 2008 12:53:30 -0400
Regarding the SME who was re-writing parts of the manual, Janice Gelb
suggested:
>
> "Thanks very much for taking the time to provide
> a new function description. I noted that your text
> <clarifies/adds these specific technical fixes>.
> However, for future reviews, please note that
> our company adheres to strict documentation
> guidelines so explaining specific technical changes
> that you'd like to see incorporated in the text
> rather than spending your valuable time rewriting
> sections that have to be modified is a more efficient
> review strategy.
>
> "I do appreciate your feedback and attention to detail."
I've been in a position to write a similar response, and it became
impossible to write something that both corrected (gently) the style
problem and lavished praise for the technical assistance and
willingness, without sounding stilted and phony. At least, to me... I
definitely didn't want anyone feeling huffy and no longer forthcoming.
I tweaked and I tweaked, and it either stopped saying what I needed to
say, or it kept sounding forced.
Finally, I solved that problem by my usual method - over-the-top
goofiness. I wrote the thank you paragraph straight, as obvious
boiler-plate then followed with something like:
"Truly your alert and careful assistance is enormously valued. Blessings
upon your house! May your herd increase and your enemies wither! ...
etc."
Next time I saw the person, I did the formal salutation of the bow
accompanied by touch to heart, lips, forehead and mock-serious
expression.
Seemed to work. I got lots of further assistance from those so-treated.
- 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.
ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial. http://www.componentone.com/DocToHelp/
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-