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:Fri, 17 Oct 2008 06:43:01 +1100
Downing, David wrote:
> The other day, I held a document review meeting, and one of the SMEs
> told me I needed to rewrite the description of a particular function to
> clarify it. Okay, fair enough. I rewrite the passages (and made various
> other revisions from the meeting) and sent out the revised text to
> everyone. 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
>
> - Grateful to him for trying to be helpful.
>
> - Angry with him for not keeping his place and trying to usurp my role.
> Hey, I'M the writer.
>
> - Insulted, because he's decided I can't write. Rather than telling me
> the passage heeds further clarification, he's thrown up his hands and
> just said, "Looks like I need to write this for him."
>
> One thing's for sure -- what he wrote does NOT conform to our
> departmental style.
>
"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."
-- 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 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-