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:"Victoria Wroblewski" <victoria -dot- wroblewski -at- eagletest -dot- com> To:"Downing, David" <DavidDowning -at- users -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 16 Oct 2008 10:06:44 -0500
-----Original Message-----
From: Downing, David
Sent: Thursday, October 16, 2008 9:00 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Honestly -- when an SME completely REWRITES your text ... GEEZ!
> I got an email back from this particular SME this morning in
> which he completely rewrite the function description for me. I'm not
> sure whether to be
> . . .
> How would you take it -- and has anything like this happened to any of
> you?
Going through this right now with an SME of my own ("programmatically"
in an end-user doc? Really?!?)....
Really, most of the time, they are trying to be helpful. And it's best
to try and keep them helpful and not discourage them.
With a calm head an some time, you can take the time to explain some of
the "why I did it this way" where you may find vast differences in your
text vs. the SME text. A lot of the time, SMEs love this - getting a
bit of the tech doc world actually explained to them so they understand
we're more than just writer monkeys. Sometimes they'll even learn from
what you tell them and you'll see vast improvements in the source docs
you get.
- V
**This transmission may contain information that is privileged, confidential and/or exempt from disclosure under applicable law. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution, or use of the information contained herein (including any reliance thereon) is STRICTLY PROHIBITED. If you received this transmission in error, please immediately contact the sender and destroy the material in its entirety, whether in electronic or hard copy format. Thank you.**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-