Editing

Multidimensional interactions have altered the basic rules of communication

Social media has drastically changed how we communicate. Not too long ago, we communicated through the mail, on a land-line telephone, and in person. Today, we send text messages; leave voice messages; use instant messenger; send emails; talk through headphones, cell phones, and online video alitas-autumn-treephones; and, of course, interact through the Internet where a plethora of social media tools has redefined communication.

Such a redefinition has had an enormous effect. The entire paradigm of social media has altered the basic rules of communication, especially between business and their audiences. The one-way communication methods of the recent past—business-to-customer and business-to-business—have been replaced by a more robust multidimensional communication model. That model is collectively called social media (also referred to as Web 2.0).

The rules of social media. To communicate effectively in the social media world means understanding the new rules of the road.

People want:

Continue reading Social Media and Its Effect on Communication

Read more

The value a technical communicator brings to an enterprise has never been higher

The number of technical writers is on the decline. So says the United States Department of Labor, the government agency that tracks such things. In its place rises the technical communicator.

It only makaena-pointkes sense. Certainly the need for simple, clear technical information has never been greater. The complexity of this information is ever increasing. To satisfy these evolving needs, the skill set of a technical writer falls short. Today’s world demands the skills of a professional technical communicator.

The evolution of the technical communicator. The Department of Labor maintains hundreds of descriptions in their Standard Occupational Classification system. This is how they describe a technical writer:

Write technical materials, such as equipment manuals, appendices, or operating and maintenance instructions. May assist in layout work.

This description is more than 70 years old. Perhaps it accurately described the work of technical writers then — but certainly not now. The work of the technical writer has evolved over the past 30 years.

The task of the technical writer gained in complexity with the advent of the desktop computer and access to software by the masses. This complexity broke open about 10 years ago with the World Wide Web and exploded like the Big Bang in this new millennium as the Web became the indispensable source for information.

A new occupational title was needed: Technical Communicator.

Continue reading The Inexorable Rise of the Technical Communicator

Read more

Monday, 7:30 AM: I sit at my office desk on a lovely Vermont morning, preparing for my workday, head down, focused, planning web edits, help text, and user guide additions when the phone rings, startling me.

“I need a favor,” the voice begins, without preamble, dangling that last word. Urgency fills the air, then “Dude! A big favor.”

tech-comm-in-social-media-3It’s Sallie, the trainer I had been contracted to work with over the past year. I smile. We are friends. Sallie travels a lot and time together, even a phone call, is precious.

“Sallie, I thought you were in California?” I ask.

“I am.” I’m perplexed a bit by this, but quickly gather the situation.

“You are? What is it, 4:30 AM there? You’re not at the client’s site working? Are you?” I fire these questions off in rapid succession.

“Yes. To all of that.” There’s a pause. “That’s why I need the big favor.”

The favor was simple to explain but certainly not simple to complete.

The Project. Before going to California, Sallie was creating new course descriptions and customizing existing ones for a new client. That was the favor: could I complete this project for him?

I had recently created some of these course descriptions myself, so I understood the content. What I didn’t know, at least at this point, was that Sallie had barely begun. The course descriptions Sallie had already outlined needed to be changed; all the new course descriptions still needed to be created. In other words, I was starting from scratch.

Continue reading Technical Communication in a Social Media World

Read more

These three editing levels ensure your writing informs and garners results

The advantages of working with an editor kept burgeoning. First there were the nine tasks of an editor, then the five levels of editing that incorporated these tasks, and finally the five extraordinary tasks that an editor could perform.

archwaySo much to consider, organize, implement, and assess. The manager was just beginning to get a handle on all this information when the team leader walked into the office.

“I’ve discovered another way to establish editing levels,” the team leader said.

“There’s more?” came the incredulous query.

“Just a different way of looking at it.” Pause. “Perhaps a better way of looking at it, actually.”

The team leader produced a copy of Levels of Technical Editing (by David E Nadziejka, ELS, published by the Council of Biology Editors: contact me for a copy) to review.

“After a little research, I’ve discovered this small guidebook. It takes a bit of a different tack with the levels of editing.”

“Why do we need another method?” asked the manager. “I haven’t even wrapped my arms around all this editing stuff, and now you want to change it?”

“I think, after I explain all this, you’ll see that this adds another set of choices for us, and doesn’t scuttle what we have already discussed.”

“Okay,” conceded the manager. “Tell me why there is a need for another take on the levels of editing.”

Here’s what the team leader passed on to the manager.

Continue reading Another Take on Editing: Three New Levels

Read more

Turns out that an editor can do a lot more than edit

After their meeting, the manager had a lot to consider. The team leader gave the manager the copy of The Levels of Edit§ to review. (§ The Levels of Edit, by Robert Van Buren and Mary Fran Buehler, published by the Jet Propulsion Laboratory (JPL), California Institute of Technology, Second Edition. See April 2012’s blog post for details.) Much of what the team said was clearly articulated in this booklet.

bustAnd to the manager’s delight, much more. The additional information would make life easier as they embarked on a measurable program of incorporating an editor into their process. Already the manager could envision a professional editor making their project studies, resource plans, technical reports, and business proposals easier to read and understand, and thus more readily accepted and adopted.

The section entitled “The Condition of the Manuscript” garnered these insights:

  • The effort required for any level of edit directly relates to the condition of a manuscript. Better prepared manuscripts require less effort; poorer ones require more effort.
  • The condition of the manuscript directly affects the budget and schedule.
  • The level of edit defines the quality of the final document, but not the effort required to attain that quality.

All these insights help predict the time and effort required of an editor, regardless of the level of editing involved. While assessing the actual amount of time creates a bit more work upfront, it clarifies the scheduling and budgeting for a project.

A final section described five extraordinary functions that an editor could perform whenever necessary. This, the manager found enlightening because there had been circumstances in the past when an editor could have helped out in many of these areas.

Continue reading Five Extraordinary Editing Tasks

Read more

Bringing measurability and clarity to the nine editing tasks, helping your writing count

As the manager read the nine tasks of an editor§, the technical team stood by and watched the manger’s body language and facial expressions change as the document was read.

salisbury-close“That’s a lot,” the manager finally looked up and said. “Nine tasks.”

The team looked at each other, encouraging expressions slowly dawning on their faces.

“It is a lot,” they said almost in unison. “That’s what we’ve been saying. An editor can get our writing to count.”

They had made their point clear, and the message was delivered, much to their manager’s credit.

“And there’s more,” they said.

“Tell me.”

Five levels of edit. “To build on these nine tasks, the booklet we told you about combined them in a cumulative manner into five levels of edits.” They listed them:

  • Level 5 Edit incorporates the Coordination and Policy editing tasks.
  • Level 4 Edit adds the Integrity and Screening editing tasks.
  • Level 3 Edit continues this trend, adding the Copy Clarification and Format editing tasks.
  • Level 2 Edit contains eight of the editing tasks by adding Mechanical Style and Language.
  • Level 1 Edit, the most comprehensive of these five levels, contains all nine editing tasks; it adds the Substantive task.

(§ The Levels of Edit, by Robert Van Buren and Mary Fran Buehler, published by the Jet Propulsion Laboratory (JPL), California Institute of Technology, Second Edition. See April 2012’s blog post for details.)

Some problems solved. “Working with these five levels enables us to solve two inherent problems when working with an editor.

Continue reading The Five Levels of Editing

Read more

Nine hierarchical tasks enable an editor to ensure your document fulfills its intended goal

They returned dejected, and a bit humbled, filing slowly into their manager’s office. Their manager started.

“What happened?”

salisbury-bridge“We weren’t invited to present.”

That was surprising. “Why not? You told me we had a great proposal, that we could clearly meet all their needs.”

“We do, and we can.”

“Then… what happened?”

“They rejected our proposal out of hand.”

“Huh? What does that mean?”

“They told us our proposal didn’t read well, that it was disorganized, wasn’t clear—‘fuzzy’ is what they said—that it rambled, was a little redundant, had some typos, and…” the hardest part, “it didn’t follow the rules of their RFP.”

“I don’t get it. I thought you guys had this all down pat, that you were expert.” It was more a statement than a question.

“We are expert in all the technical aspects required in the RFP. But…” The pregnant pause hung in the air. “But, as we’ve said before, it’s one thing to be technical experts, it’s another thing entirely to be able to communicate that expertise clearly, concisely, and conclusively. That we struggle with.”

The feeling of disappointment was almost palpable. Mildly accusatory glances circled around.

“We have a solution though.” Wary eyes. “We’ve said this before.” Wary looks. “We need an editor; it’s not a luxury.”

Continue reading The Nine Tasks of an Editor

Read more

Your editor is not adjunct, but essential to your writing’s clarity and cohesion

“Of all the gin joints in all the towns in all the world, she walks into mine.”

One of the most famous and memorable lines in all of movie history wasn’t written by the script writers—it was created on the spot by Humphrey Bogart while filming one of the many lightening-rod scenes in Casablanca. Not only is Casablanca stonehenge-2011considered the best movie of all time by most film critics, but its script is also considered the best of all time by the Script Writers Guild. Even with those sterling achievements, Bogart’s ‘editing’ of that crucial line improved the dialogue and the film. As a result, the line endures 70 years after Bogart uttered it.

This is the value that an editor enmeshed with the writers can bring to improve written text.

Self-editing as a choice. More than likely, neither the documents you write, nor the ones I write, will carry the same longevity of Casablanca’s script. Nonetheless, your writing is important. And yet, many of us—myself included—often self-edit and eschew the brilliance that an editor can bring to our writing.

Make no mistake, self-editing often is a useful way to improve your writing. Letting text you’ve labored over to rest for a few days enables you to see that text from a new and expanded angle when you return to it. There’s a renewed clarity after your subconscious has stewed, which allows you to improve and build upon your initial text. In general, though, you are still bringing the same mind-set to your text, using the same base of information and perspective that you brought at the beginning.

Continue reading An Editor: Your First Reader and Collaborator

Read more