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:"John Posada" <jposada99 -at- gmail -dot- com> To:"Gary Schnabl" <gSchnabl -at- livernoisyards -dot- com> Date:Fri, 17 Oct 2008 08:35:31 -0400
> Probably... Correct, accurate writing from an SME in a less-than-ideal
> format is far better than some erroneous, but better-written, pap
> authored by a TW.
>> - Angry with him for not keeping his place and trying to usurp my role.
>> Hey, I'M the writer.
> Besides, that component of the document he entirely rewrote was probably
> but a few pages long relative to the entire document. So, live with it
> and just make his writings conform to the style and format guidelines,
> much as in the role of an editor.
I will say that the writer has more of a role in a situation like this
than simply make sure it complies with a style guide.
My experience has been that in many cases, the SME, because he knows
more, will include it. However, it may be that the context of the
document does not require the full depth of what he wrote. Sometimes
SMEs include too much "what", when what we need in the document is
more "how". For instrance, in an installation procedure, it may not be
the proper place to explain something when it may be more appropriate
to explain it in the configuration guide or the API documenrt.
Often, I have to remove 10-25% of the details because they are not
required for the context of the manual, though I will keep his content
around ikn the event I find a more appropriate place for it. However,
after I do, I'll send it back to the SME to review to make sure I
didn't distort the meaning.
Senior Technical Writer
NYMetro STC President
'Half this game is ninety percent mental.'
-- Danny Ozark, Philadelphia Phillies manager
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-