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.
"I had at least one thing in common with Joseph Conrad: English was my second language. Unlike Conrad, I had no first language."
-- Kurt Vonnegut
For many engineers who were born and raised in the US, English is their second language, and Engineering is their first language. This happy fact keeps technical writers employed.
-----Original Message-----
From: Lynne Wright
Sent: Wednesday, November 13, 2013 2:03 PM
To: Alec Chakenov; Peter Neilson
Cc: techwr-l
Subject: RE: [TechWhirl Forums] Authors who cannot write
Are you referring to SMEs expressing what they mean in their own language? That's how you end up with documentation that users can't understand... because the writer just paraphrased what an engineer or programmer said. Which, in my case, because my SMEs' first language often isn't English, would result in incomprehensible text.
Similarly, SME reviewers will often approve text that they think is ok (because they completely understand how a feature works), without realizing that it's confusing, unclear, or full of holes to somebody who's coming at the material with zero knowledge.
The tech writer has to understand what they are documenting so that they can explain it in clear simple language. It's the opposite of letting your SMEs basically write the text for you verbally.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
