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.

Two spaces after a period?? I didn’t know anyone still did that!

I’ve been a copywriter and an editor for close to 15 years. When I started, I had a reputation as “the red pen lady.” Actually, many of my clients probably still call me that, and I don’t mind. It just means I’m doing my job.

 
Considering that some of my first clients weren’t native English speakers, you can imagine the fun I had with that red pen. I tried to school them in AP style, which included eliminating the serial comma, using a lot less capitalization and utilizing a single space after a period. This last change was harder than I had expected. Many had been taught that a double space was correct, and they didn’t want to give it up; since it was early in my writing career, I didn’t push.

That was 2001. Since then, I’ve pushed a lot, and I have been pretty successful at getting clients to change to single spacing. But when asked why, I’ve never been able give a definitive explanation, other than to say it’s because I follow the AP guidelines (page 334 in the edition I have). All of the “big” style manuals, AP, Chicago and MLA, specify one space after a period. And for those academic types, the APA (American Psychological Association), recommends single spacing in published works, even though they allow double spacing in drafts.

An article written in 2011 but updated and reposted last week on Business Insider reignited the “one space versus two” conversation. The author, Farhad Manjoo, is a bit pretentious in a likeable sort of way, and he asserts that a single space is the only way to go. He has a concrete explanation. Apparently the early history of type included a mishmash of everything – spelling, spacing, etc. – everyone did what they wanted, nothing was standard and texts were often difficult to read. Typographers, those who study and design the typewritten word, decided it was time for standards, and they agreed on single spacing, among other best practices. It was that simple. Europe adopted the rule in the early 20^th century, and America followed shortly after.

In the early 1980s, my typing teacher insisted on double spacing, and it made sense for typing on a manual typewriter; the size of typed letters was inconsistent and double spacing clearly indicated the end of a sentence. At some point in college, maybe after my first computer class (Anyone remember DOS?), I switched to single spacing. It must be old age; I have no recollection of the exact timing, or why I switched. I continue to single space because the experts, AP, Chicago etc., tell me to, but now I can say it’s because the experts decided on it a century ago.

I’ve been asking colleagues, friends and clients, including other graduates of my Hopkins MA in Writing program, what they follow. My small, very unscientific survey showed a pretty solid commitment to single spacing:

“Always, always single.”

“I'm a full time tech writer. First thing I do to every document I touch is a Find/Replace to swap two spaces for one. Thesis was single space, too.”

“Two spaces after a period means you are old. That's all. From typewriting class. When I unlearned it (after failing an employment typing test because of it), I felt immeasurably younger.”

“I'm constantly taking them out of other people's writing. It drives me nuts. In grant writing space is at a premium and I need all the character space I can get!”

“I'm a one space guy and don't even remember where I picked that up.”

“I have been reminded, time and time again, for years that there is only one space after a period. Old habits are hard to break. “

If single spacing is the accepted best practice, why do some still not do it? I had dinner this week with three of my favorite people. All of them are double spacers, and none had a real explanation. They said it’s just always what they’ve done. One went so far as to say that when she can, she changes single spacing to double. Another, although she’d heard that single spacing is the accepted way, just can’t bring herself to change.

I honestly think single spacing looks better than double spacing, and it reads better, and I think readers are happier for it. I am a fan of white space, but I also believe too much white in text makes readers pause for too long, and when that happens, their brains wander. To deliver a message appropriately means readers should not stop, even for a millisecond, and consider leaving the page.

Where do you fall? “They” say that it takes 30 days to create a new habit, so it also takes 30 to kill an old one. Start counting the days, as double spacing after a period is one habit I’d like to see you break. In return, I’m willing to consider giving up my disdain for the serial comma.

WHEREABOUTS: Stepping Out of Place, An "Outside in Literary & Travel Magazine" Anthology, oh and The Legend of Sleepy Hollow

Grave of Washington Irving

This past weekend, my mother-in-law and I toured the Sleepy Hollow Cemetery, 15 minutes from where my husband grew up and his parents still live. Our first stop was the grave of Washington Irving. It was a grey, misty morning, the perfect setting to learn about the writer of some of my favorite stories, including Rip Van Winkle and The Legend of Sleepy Hollow. I was very happy to hear he was one of the first writers to figure out one could make a living as a writer, and it didn’t need to be a side gig!

Our morning reminded me I hadn’t yet leaked the details of my latest publishing adventure. It’s one I’m thrilled to be sharing with my friend, Brandi Dawn Henderson, and a number of other “crazy talented” writers. Brandi is main brain behind Outside In Literary & Travel Magazine, and I mentioned in my last post that we're working together on a project.

The first anthology from Outside In, called WHEREABOUTS: Stepping Out of Place, An "Outside in Literary & Travel Magazine" Anthology, was published last week. It’s a compilation of the best nonfiction from the magazine, which Brandi started in 2011. She and her editors thought the piece I submitted, “Beauty,” was worthy of inclusion, and for that I’m very grateful.

The release is being celebrated with two events, one at Johns Hopkins University in Baltimore on October 12th and one in DC on the 16th. I’ll be at both, especially since I'm reading my piece at the event in Baltimore. The Baltimore event (scroll down the page for details) is at JHU’s Homewood campus in the Levering Lounge and starts at 6 with a cocktail hour. Readings start at 7. Readers are all Johns Hopkins University alumni:   me, Michele Fizzano McFarland, Shenan Prestwich, Vicki Valosik and Dario DiBattista (reading from his recently released memoir). The DC event is the official launch. It’s at 6:30pm in room A-5 of the Martin Luther King Jr. Memorial Library. Readers are Paula Cruickshank, Adrian Mangiuca, Angela Magnan, Shenan Prestwich and Vicki Valosik.

Hope to see you at one or both. If you can’t make it, or even if you can, I’d highly recommend buying the book, available on Amazon. It’s a great gift for the traveler in your life.

BTW, there are some Rockefellers and Chryslers buried at Sleepy Hollow. And the infamous Leona Helmsley and her husband are there as well. We’re saving those for our next trip to the cemetery, now that Mama Vera wants to do the 2-hour tour.

Harvard Business Review’s Guide to Better Business Writing: When I’m not there to edit

“Do you freeze when you learn you have to write memos to senior executives”? Do your reports meander and raise more questions than they answer for stakeholders”? Those are the first two lines of HBR’s Guide to Better Business Writing, a book I think should be in every business person’s library. And one they should use, not just let collect dust.

In just over 200 pages, it summarizes the key tips, tools & tricks individuals need to write pieces that are clear and meet their intended goals, and I think it can ultimately make writing easier and less painful. Subjects range from understanding readers to the dos and don’ts of business writing etiquette and how not to “anesthetize” readers. Only a tiny fraction of the book is about grammar, which does my heart good. I’m not dissing grammar; I think it should be high on the writing checklist, just not at the top. Oh and there’s a really complete writing checklist in the book, starting on page 139.

I stumbled on this practical, informative guide, which BTW, I get nothing for talking about, while gathering research for a new project I'm working on with Brandi Dawn Henderson, a fantastic writer, editor and teacher (Check out Outside In Literary &Travel Magazine, the quarterly journal she edits. The next issue is due out October 5th.). We are developing a training program to give employees of small and medium sized businesses faith in their ability to write and help them deliver pieces that are clear and accurate as well as message and audience appropriate. Stay tuned for details on “Conscious Writing for Business."

For some, even me at times, writing can be a terrifying, solitary, boring sport. There are days where those first words just won’t come and when they do, they’re just awful. Earnest Hemingway once said that “the first draft of everything is shit,” and I think this book (coupled with our training of course!) is a great tool for moving that final version of a memo, a report or even a simple email, far from shit and towards greatness.

I’ve had the book for a week and I find myself flipping through it daily, along with my ancient copy of the AP Stylebook. What’s your secret to ensuring your writing doesn’t put your readers to sleep and delivers as intended? Leave your comment below.

8 months to figure out I had cataracts? There’s a story there!

I’m always looking for things to write about. Sometimes my random thoughts sit in a journal for weeks or years before I do anything with them. Some don’t ever see print. But occasionally I'm driven to get these musings to the public, if for nothing more than to make me feel better.

This piece, published in the most recent issue of the Wharton Healthcare Management Alumni Association Newsletter, tells my lessons learned from uncomfortable dealings with the medical establishment in 2012 and early 2013.

In late 2012, I was diagnosed with cataracts in both eyes; two months later, I had very simple surgery to remove them. The diagnosis came about eight months, three different types of contacts, four doctors, and approximately seven consultations after I first told my eye doctor the glasses with progressive lenses I’d been trying to wear for the past several months weren’t working.

Neither doctor(s) nor patient (I didn’t get off easy!) took the extra time to ask the right questions; Plus, the doctors continued to think of cataracts as a purely age-related disease. Now that I’ve had the surgery, I can look back on the event clearly (no pun intended) and unemotionally. My hope is that after reading this, you’ll see your next visit to a doctor a bit differently. Perhaps you’ll do your research before your first visit. Or if you’re a doctor, maybe you’ll take an extra minute or two with your next patient to think outside the box.

BTW, the doctor (and friend) I quoted in this piece, Dr. Sanjay “Sonny” Goel, Executive Medical Director for LasikPlus Laser Vision Centers and Visium Eye Institute also had an article published in this issue of Wharton. It’s about the rising costs of healthcare as they relate to cataract surgery. Be sure to check it out.

Have you ever felt like you just HAD to share an experience to anyone who would listen? How did you tell your story? Share in the comments below.

Without My Girls, Where Would I be Today?

Circa 1978

More than two million girls are Girl Scouts, and more than 59 million American women were Girl Scouts as kids. Plus:

• 10 of 17 women (59%) in the US Senate are former Girl Scouts.
• 45 of 75 women (60%) in the House of Representatives are former Girl Scouts.
• 54% of all women business owners are former Girl Scouts.
• 76% of Girl Scout alumnae say Girl Scouts had a positive impact on their lives.

I found my Brownie pin last week, and the timing was perfect, as I’m now one of the co-troop leaders of Brownie Troop #10281 in Reservoir Hill, a neighborhood in Baltimore City.

If I did the math right, I received my pin in 1978, during meetings in the lunchroom at Church Lane Elementary in Randallstown, Maryland. I doubt I thought much about its significance then; I was just happy to be with my friends and do fun things to earn badges, oh and to sell cookies.

Today, my eight new best friends, precocious 7- and 8-year olds, come together from a wide range of experiences and socioeconomic backgrounds, to have fun and develop the skills they need to contribute to their schools, their neighborhood and the larger community, now and well into the future.

I’m excited (and a tiny bit scared) to be doing for them what my troop leaders did for me. Girl Scouting taught me to speak up for myself, developing my courage, confidence and character, i.e. the skills all girls need to be leaders. Without my years in Girl Scouts, I’m not sure I would have taken the path I did, getting a degree in chemistry and having the courage to change careers several times till I found the one I loved, one that focuses on the sciences and technology.

Statistics show reduced numbers of women in STEM (science, technology, engineering & math) fields. But my lovely ladies have ignored that statistic, and have chosen to start their Girl Scout year off on a scientific journey that will teach them to be responsible stewards for the earth. We, the leaders of Troop #10281, are going to do our part to get them interested and keep them there.

Were you part of something that helped form the adult you are today? Were you a Girl Scout, Boy Scout or member of another organization, and if so, are your kids involved today? Feel free to share your experiences below.

My first post. I feel like a baby taking its first steps.

And I'm off! Thanks for coming along for the journey.

Writing has to inspire, whether it’s a technical sales brochure about the latest piece of software or a “have your boobs” checked article about breast cancer. If a piece doesn’t make you want to do “something,” it hasn’t done its job; it’s just a page of words.

Let's kick this off with two very different pieces. One, published earlier this year in the Wharton Healthcare Quarterly, is about living with male breast cancer. The second, out this week in ThomasNet News’ Industry Market Trends, is an overview of Master Data Management, and details how implementing MDM can help manufacturers make better use of their data.

For those who don’t know me, not everything I write is highly technical or science-driven. One day soon I’ll post some pieces to make you giggle. Maybe you’d like the one about picking up a dead rat from my backyard or the one about sunbathing nude in Croatia?

Here's my question for you: what will make you come back and bring your colleagues and friends? Do the writers want writing prompts & contests? Do current & future clients want more examples of my work? How about some examples of really bad grammar? Or, do you want pictures of my office mate, my dog George? A list of my favorite books? Ask and you shall receive.

Whatever the future brings for this page, I hope you'll find it a fun, informative and interesting place to spend a few minutes. Leave a comment below, so I know you've been here!