Tuesday, February 25, 2014

Faye Rivkin: what do you do as a technical writer?

Recently, I talked with two women looking to jumpstart their writing careers. Our conversations were wide-ranging, and I’m looking forward to watching their careers take off. We chatted about all kinds of freelance writing-related stuff, like rates, proposals and non-disclosure agreements (NDAs). I’d wager that most of you didn’t know those activities were part of writing.

There are probably more than a few people who aren’t really clear on what it means to be a technical writer. This is the group that looks at me blankly, smiles, nods a few times and says “ah,” when I tell them that’s what I do. Well, it’s time to fix that. 


The short version
I eliminate the pain that comes with creating compelling content, which allows my clients to communicate effectively and with influence.

The details
Every technical writer has his or her areas of expertise. I concentrate on a few industries – hardware and software, science and medicine, education and law – taking highly technical data and turning it into content that’s appropriate for its audience, whether an audience of engineers, scientists, safety technicians or purchasing managers. Purchasing managers, for example, don’t need the level of technical detail required by engineers and scientists, and in some cases, including it can be a detractor and could end a sale. Once I understand the audience and message, I know what to include and what to leave out.

One of my major tasks is to repurpose extremely technical content to explain procedures, define processes and sell products. The resulting documents (see my list of types below) deliver information that allows users to do things like:

  • Install and use software applications,
  • Understand product specifications,
  • Safely operate equipment,
  • Comply with a law, and
  • Meet a regulation.
Or perhaps, it’s to meet a simpler need, like eliminating the chance of embarrassment by reviewing an article before it’s submitted to a journal. I find errors missed by the author, who may have reviewed the same document 12 times.

Whatever the reason, my work allows my clients to focus on their critical tasks. In some instances, I rewrite and revise existing copy. In others, I write a piece from start to finish. How can I do that, if I’m not an engineer, biologist or lawyer? My background and years of experience, my ability to ask the right questions (working as a recruiter allowed me to develop these skills) and my access to subject matter experts, make the process work.

The types of technical content I produce

  • Web copy
  • Brochures
  • Press releases & other marketing copy
  • Frequently asked questions (FAQs)
  • Requests for Proposals (RFPs)
  • Instructions & training materials
  • User manuals
  • Journal articles
  • Technical reports & data sheets
  • White papers

Examples of my work
Much of what I write is covered by NDAs or is ghost-written, and you’d never know I had anything to do with it. But, there are a number of pieces I’m happy to, and allowed to, share. Below are a few. There’s more on my web site, and I’ll share additional samples in the future. 
 

Recent web sites
SmartLink, LLC
Thornton Service 
 

Longer form copy
"Delivering Technology Projects on Time, on Budget and On Value,” Tech Trends Journal

“Like It or Not, You Need a BYOD Policy,”Tech Trends Journal
“Additive Marketing Technology and Smart Packaging: A Reality Check,”
Industry Market Trends

Make sense?
Some intricacies are specific to each customer, like using style guides and working with designers, but this should give you a good overview. How’d I do? Did you already have a good idea of my job, or was this a useful tutorial? In my next post, I’ll share with you just how I got to this point. That is a story in itself.


No comments: