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.
Subject:RE: Breaking into the tech writing job market From:"Mike Schmidt" <mschmidt -at- weathercentral -dot- tv> To:"Robotti, Anne \(Carlin\)" <ARobotti -at- CarlinGroup -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 9 Aug 2006 08:57:39 -0500
I'm repeating what I've been taught. It's not condescending at all. The
theory is that many don't refer to the manual until they're having a
problem (myself included), and at that point, they don't want wordy,
grammatically perfect novel writing. They want: "To make it go, push the
green button."
My first boss (and mentor in this field) used to write like we was
writing a novel. Too wordy, too involved, etc. I agree that you need
simple, concise, easy-to-read steps. Hence, a 6th grade level.
-----Original Message-----
From: techwr-l-bounces+mschmidt=weathercentral -dot- tv -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+mschmidt=weathercentral -dot- tv -at- lists -dot- techwr-l -dot- com]
On Behalf Of Robotti, Anne (Carlin)
Sent: Wednesday, August 09, 2006 8:53 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Breaking into the tech writing job market
> Something we have a lot of in our audiences. If you remember your
> basic intro to tech writing classes, they tell you to write at about a
> 6th grade level.
I think that's a very condescending and obnoxious thing to say. And it's
probably a root cause of the "users is soooooo stupid" attitude that
makes a lot of engineers and tech writers unbearable, IMO. If you're
writing for adults who are brand new users of a technology or product,
you have to be particularly clear about each step, which you should be
anyway. There's no reason to term that "a sixth grade level" and it sets
up bad karma.
Carlin Equities and its affiliates' (Carlin) e-mail systems are for
business purposes only. Messages are not confidential. Authorized
supervisors, compliance personnel, or internal auditors may review all
e-mail. E-mail will be archived for at least three years and may be
produced to regulatory agencies or others with a legal right to access
such information. Carlin will not accept trade order instructions via
e-mail. Please telephone your firm representative or the Order Room to
place trade orders.
Please be advised that any discussion of U.S. tax matters contained
within this communication, including any attachment, cannot be used for
the purpose of avoiding U.S. tax-related penalties or promoting,
marketing, or recommending to another party any transaction or matter
addressed herein.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-