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:Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 22 Oct 2008 07:32:01 +1100
Doug Cuff wrote:
>> The reason it got me upset was that, by just rewriting the passage
>> himself, as opposed to telling me what needed to be corrected, he seemed
>> to be saying, "You're making such a mess of this that I don't think
>> you're capable of understanding what the problem is, so I'm just going
>> to have to do it for you."
>
> I still get the impression it says, "I am able to express my own thoughts in my own writing but am
> unable to edit someone else's writing."
>
> People with skills sometimes forget that not everyone possesses them, not even to a small degree.
> It took me awhile to realize that not everyone can do what I do--I guess partly because I endured
> so many years of people assuming that they could.
>
I don't think that the SME's task was to edit
the author's writing. The task was to note and
possibly correct the technical content of the
information. Saying "This is confusing/doesn't
include this necessary information/is technically
incorrect" does not require editing or writing
skills.
While I probably would rather get a rewrite than
a useless question mark at the side of the page,
as I've seen in the past, I still think that it's
not unreasonable for the writer to want to tactfully
let the SME know that for future reviews, the most
efficient solution is for the SME to indicate what's
wrong rather than rewriting it. The SME probably
thinks that providing new text is helpful and perhaps
would be grateful to learn that all that is expected
is an indication of what needs to be changed to make
the text technically accurate.
-- Janice
***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
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-