Writing

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

A clear, compelling objective forms the foundation of every great presentation

“Where are we going?”

My teenage son and I sat in the car in our driveway. He was behind the wheel, beginning another training session as he learns to drive. No engine started yet, when he posed that question. I just looked at him quizzically.

bikes“You’re kidding, right?”

“No”, he said. “I don’t know where we’re going.”

I sat in silence for a bit, absorbing that. Okay, I thought, let’s start somewhere else.

“What are we trying to do?” I tried.

“Buy sneakers for me.” That’s good, at least he knew that.

“And where might we get those?”

“I don’t know.” The standard teenage response. Then he thought for a second. “How about the outlet mall? There’s a couple of stores there.”

“Let’s go then”, I said.

He started the car, and rolled a short distance, then stopped. He just sat there staring straight ahead. He looked deep in thought, pondering. I looked at him again, wondering.

He slowly turned to look at me, and with a look of chagrin said, “How do I get there?”

I laughingly smiled.

“You don’t know how to get there?” I asked with some incredulity.

“No”, he stated matter-of-factly. “How would I know that? I’m used to just sitting there and going along for the ride.”

Let’s pause the story there, and shift gears from driving to presentations.

Continue reading Where Are You Going with that Presentation?

Read more

Your ability to visualize—to see— information greatly enhances comprehension

Anyone who has watched a teenager take driver’s ed can empathize—even if that teen isn’t your own. The angst, the “omg, not my car!”. That’s one of the beauties of driver’s ed: the teen learns on someone else’s car. As is my teen. Yesterday, when he came home from school, I was pleased that was the case.

“How was school?” I asked.

park-boy“Good.” (Don’t you just love those informative one-word answers?)

“How was driver’s ed?” I persisted.

Pause. Then finally, “It was okay.”

The story. Now, as any parent worth their salt knows, when there is a pause, there is trouble.

“What happened?” I asked matter-of-factly, cutting right to the core.

My son just looked at me with wary eyes. I could see that he was measuring his words in his mind, struggling to decide just what to say.

“The car broke down.” He ventured in a slightly hesitating voice.

Now I knew immediately that this was just the title of the story, that there was much more to hear. The question remained though: could I coax that story out of him? Worth a try. I had a feeling this was going to be good.

Continue reading Yes, I See That

Read more

The design of your communication must be on par with its content

This past June, I was attending my son’s lacrosse tournament. We wanted a down-to-earth place to eat breakfast. The locals recommended a nearby diner. Now you know what a diner looks like: silver façade, booths with plastic seats, counter and stools, coffee machines and blenders and that little window into the kitchen, slightly cramped. You can picture it, right? Sounded perfect, so we went.

breakfast-clubWe walked in and looked around. Lots of people, but no waitresses. After a few moments, the swinging doors from the kitchen popped open. Out walked an elegantly dressed man, tux and bow tie, replete with cummerbund and gleaming black shoes. He approached, bowed, and said in a proper tone, “Good morning gentlemen. Have you a reservation?” I raised my eyebrows. “Apparently not,” he intoned flatly. “Fortunately,” he said in a brighter tone, “we’ve just had a cancellation. Please, follow me.” Turning crisply, he walked toward an empty booth. After we sat, he pompously handed us each a stylish menu. Then addressed me formally: “Could I interest you in our reserve wine list? A crisp white would prove a fanciful accouterment for this lovely Sunday morn.”

Confused? Well, if this had been reality, we would have been too. When you walk into a diner, you expect things a certain way. But not this way. To put it another way, this diner’s look did not match its content.

A more pertinent perspective. A long, long time ago (in a galaxy far away), I was approached by a software company to work on their documentation. The docs were basic reference and how-to manuals, describing their menu and explaining their function. They were written by an engineer—who also had a penchant toward inserting references to popular cultural philosophies and weaving their ideologies into the text. Interesting since this ersatz writer-engineer took pains to make the context of these fairy tales relevant; most ended up mild rants.

Continue reading How Does It Look?

Read more

Landmark legislation places an even higher value on accurate, complete technical documentation

Seventy-seven million dollars ($77 million)! That is the amount of money SAS AB is seeking in compensation from Bombardier, the Canadian-based aircraft maker, for omissions in Bombardier’s technical maintenance manual for their Q-400 turboprop plane.

Two of SAS AB’s Q-400 planes were involved in emergency crash landings in Denmark and Lithuania, both involving malfunctions in the plane’s landing gear. (No one was seriously injured in the accidents.) As a result, SAS AB grounded their entire fleet.

international-signpostSAS spokesman Hans Ollongren said, “The incidents were caused by flaws in components not included in the maintenance manual. This is why we feel the responsibility lies with Bombardier.” Ollongren said that SAS has lost about $62 million since the grounding of their fleet of Q-400s. “There are other costs involved, too, related to credibility and our flight safety record,” he continued. SAS wasn’t the only company affected; about 60 of the 160 turboprops in use by airlines worldwide were grounded.

SAS wants to resolve this matter privately between the two companies. Failing that, SAS has every right and intention of litigating against Bombardier. Can they litigate? For flaws in a maintenance manual? In the European Union (EU), in Canada, in some U.S. states, and increasingly around the world, SAS has tort law fully on their side.

Tort law creates liability issues for poor documentation. In 1998, the EU drew up legislation that recognizes technical documentation as part of a product. This is landmark legislation. Now, the documentation and product are inexorably tied together for liability purposes by this tort law. Corporations are legally responsible for customers not knowing how to use their products and for using them incorrectly.

Continue reading The Increasing Importance of Tech Comm

Read more

An e-reader changes ones perspective on the ageless act of reading.

I received a Kindle for Christmas — a gift from my oldest son. He thoughtfully bought me the 3G version, and took the time to explain why this more robust version would be more versatile for me.

library-patronIt’s a handy gadget, especially when I travel. It’s nice too. I’m slowly getting used to using it. Still, it is a big change from reading a book.

Just like our cell phones, the Kindle (and any other e-reader) has taken a common task and, in some respects, made it much more difficult. To be sure, its features are far more robust than that of a book. Still, there is a learning curve. To begin, I had to sift through a rather extensive user guide just to learn how to use it. There is a basic skill set and an aptitude I had to gain before I could use it for its intended purpose: reading.

I find browsing for books online with brief summaries and small avatars a bit constraining, versus flipping through a book’s pages and easily seeing other books on the same topic at a bookstore. There’s a tactile part that is completely missing. But oh, is it convenient. I don’t have to travel to a bookstore, I can locate more books, no out-of-stocks, and get them immediately. (No café for coffee drinks though. Oh well.)

Continue reading My Kindle, For Better or Worse

Read more