Friday, August 04, 2006

Editing for reading ease

Much bureaucratic writing is dense and difficult to read. Careful editing to ensure reading ease, but cutting down on passive voice, using plain, straightforward language (particularly reducing jargon), and organizing thoughts in smaller chunks can go a long way toward making a report more readable. Here is an example.


BEFORE


The Bank’s experience suggests an additional caution with regard to privatization in post-conflict situations. There must be adequate capacity in the government to plan, implement and oversee the process. In addition, the state enterprise(s) to be privatized must be sound enough to attract private investors or managers. The experience of Rwanda suggests that the Bank pushed prematurely for privatization of the major utility, before the government had the requisite knowledge and capability to proceed, and before the management and operation of the utility itself were sufficiently strengthened to attract even a private sector management contract, let alone investors. The Bank’s approach has recently been modified and technical assistance is being provided to strengthen the management structure and systems of the utility before attempting again to attract a private management firm. Privatization of agricultural marketing entities was a second tranche condition, one among a wide range of conditionalities for SAL I (L3293) in El Salvador. The Implementation Completion Report for the project points out that implementation of this measure, while ultimately carried out, was delayed by stiff political and labor opposition. Whether this condition should have been part of this first SAL, approved in 1991 during a critical period while Peace Accords were still being negotiated, is open to question.


Words209
Characters1201
Paragraphs1
Sentences8
Sentences/Paragraph8
Words/Sentence26.1
Longest Sentence51
Shortest Sentence14
Characters/Word5.6
Passive50%
Reading Ease22

AFTER


The urge to engage in post-conflict privatization should be tempered by two concerns. First, the government must have adequate capacity to plan, implement, and oversee the process. Second, enterprises targeted for privatization must be sound enough to attract private investors or managers. The Bank’s privatization experiences in Rwanda and El Salvador are illustrative.


In Rwanda the Bank’s push for privatization of the major utility may have been premature. Bank documents suggest the government lacked the knowledge and capability needed to proceed. Moreover, the utility’s management and operation were not yet strong enough to attract a private sector management contract, let alone investors. The Bank, to its credit, recently modified its approach in this case. Now technical assistance is strengthening the management structure and utility systems before making another attempt to attract a private management firm.


In El Salvador the Bank made privatization of agricultural marketing entities a condition for disbursement of the second tranche of SAL I (L3293). Here, the history is important. The SAL was approved during sensitive peace negotiations in 1991. According to the project’s Implementation Completion Report, stiff political and labor opposition subsequently delayed the required privatization. In hindsight, the condition probably should not have been part of the SAL.


Words203
Characters1190
Paragraphs3
Sentences14
Sentences/Paragraph4.7
Words/Sentence14.5
Longest Sentence23
Shortest Sentence5
Characters/Word5.7
Passive14%
Reading Ease31.7

Friday, July 14, 2006

Characteristics of well-written evaluations

Most of my work for the past 10 years has involved evaluation, a sub-genre of bureaucratic writing with some very particular requirements. Chief among them is that the report must communicate to policymakers and provide them with the information they need to make decisions. Though the following list of characteristics was developed specifically for evaluation, many of them are appropriate for any sort of institutional writing.


A well-written evaluation answers these questions early in the report:

  • Why did you do the evaluation?
  • What did you do?
  • Who did you do it for (who else might benefit)?
  • How do you expect the results to be used (directly influence policy, affect conceptualization, persuade others of a new direction)?

A well-written evaluation is also:


Easy to Use

  • Material organized coherently and in a way that will make sense to the reader
  • Clearly labeled sections, tables, charts, boxes
  • Main points summarized in predictable, convenient location
  • Explains its metrics, models, and methods
  • Written with the audience/reader in mind
  • Visually effective – uses elements to help browsers find what they need without having to wade through acres of text
  • Length appropriate to the argument presented

Easy to Understand

  • Delivers what it promises, does not over-promise, does not deliver more than is needed
  • Illustrates general points with specific, easily understood examples
  • Answers the evaluative questions it poses (clearly identifying them as the answers)
  • Avoids ambiguity and abstractions
  • Explains its concepts
  • Avoids clichés, tired metaphors, overused or vague language, and jargon
  • Is free of generalizations, misstatements, exaggeration, pontification, advocacy, inconsistency, and irrelevancies
  • Presents all the evidence necessary to support its main points
  • Leads the reader from evidentiary facts, to conclusions, lessons, and recommendations

Thursday, May 18, 2006

Role playing

The phrase play a role is trite and uninformative. Trying to salvage it by modifying role with such words as significant or active does nothing to improve it. What is called for instead is a precise, active verb. I offer the following alternatives.

Find the right verb
Before: Whether the project played a significant role in these changes is unclear.
After: Whether the project influenced these changes is unclear.

Before: Financial incentives are beginning to play an important role in behavior of commercially oriented enterprises, even when they are government owned.
After: Financial incentives are beginning to affect the behavior of commercially oriented enterprises, even when they are government owned.

Many other verbs suggest modest or indefinite action, among them: participate, share (in), engage (in), help, aid, assist, cooperate, support, influence.

Or cut it
Before: The government policy of requiring a fixed reduction in coal ash content is, in our view, a misguided attempt to set rules by administrative fiat, rather than allowing the market to play an active role in determining the appropriate technological choices.
After: The government policy of requiring a fixed reduction in coal ash content is, in our view, a misguided attempt to set rules by administrative fiat, rather than allowing the market to determine the appropriate technological choices.

Before: The program plays a catalytic role of helping poor, less-creditworthy municipalities to develop, grow, and eventually "graduate."
After: The program helps poor, less-creditworthy municipalities to develop, grow, and eventually "graduate."

Wednesday, May 17, 2006

Writing secrets of the pros

Follow these rules and I promise you will get results!

1. Start with the end in mind.
Do not wait until all the results are in to craft your conclusions. Write them first, that way you can make sure the research comes out right.

2. Manage expectations.
Devote several pages to the lack of data, uncooperativeness of interviewees, and indifference of managers that kept you from learning anything very useful.

3. Build suspense.
Why tell readers right away what they want to know? Drop it casually at the end of several pages of background. Better yet, bury it in the middle of the report. Readers love a good treasure hunt.

4. Showcase your skills.
Why let readers sail along on short sentences in plain English? Use your vast command of languages (don’t limit yourself to English) to dazzle them with unfamiliar vocabulary, impenetrable jargon, and elaborate sentence structures.

5. Match the writing to the ideas.
Complex ideas demand complex writing. If it takes you days or weeks to figure out what is going on in your organization, it should take your readers at least that long to figure out what you have to say about it.

6. Rules were made to be broken.
Only truly gifted or engagingly eccentric writers can break the rules of grammar with abandon. Show them how gifted or eccentric you are: toss out the rules you don’t like, experiment with alternative spelling, explore the limits of sentence length. Remember the immortal words of Humpty Dumpty in Alice in Wonderland: “When I use a word, it means just what I choose it to mean—neither more nor less.”

7. Leave interpretation to the pros.
Do not waste time clearly labeling your charts and explaining what they show, let the readers interpret them their own way—they’re going to do it anyway.

8. Neatness counts.
Bullets look like mouse droppings and headings interrupt the flow of ideas from page to brain. Blocks of text unhindered by such nuisance devices not only look better but also offer readers a more stimulating mental workout.

9. Make readers feel useful.
Do not edit the report yourself; everyone else is dying to do it for you. They enjoy finding all of your bizarre or amusing errors—not only does it make them look bright, it keeps them from looking too closely at the substance.

10. Leave them hungry for more.
Everybody loves a mystery. Sprinkle your report with red herrings, dead ends, and superfluous detail. Never be positive when you can be negative; never concrete when you can be vague; never clear when you can be misleading. Above all, follow the dictum “half an idea is better than none.”

Tuesday, May 16, 2006

Nine maxims of human discourse

Although originally used to characterize human conversation, these maxims apply equally to written communication. I keep them posted where all can see them.

1. Do not say what you believe to be false.
2. Do not say that for which you lack adequate evidence.
3. Be relevant.
4. Make your contribution as informative as required.
5. Do not make you contribution more informative than is required.
6. Avoid obscurity of expression.
7. Avoid ambiguity.
8. Be brief.
9. Be orderly.

From H.P. Grice, Language Files (Department of Linguistics, Ohio State, 1994)

Monday, May 15, 2006

Write to communicate

One principle I have tried to instill in report writers "always think of the reader first". Much bureaucratic and academic writing tends to be author-centric. That is, it makes few concessions to readers and shows little concern for communicating to other human beings. The table below summarizes the differences between writing that is reader-centric and writing that is author-centric.

Reader-centricWriter-centric
Satisfies the readerIndulges the writer
Assumes specific use(s)Assumes generic use (or no use)
Based on known audience needsBased on writer's idea of audience needs (hunch)
Emphasizes formEmphasizes content
Summarizes research findingsRecords/reports research process
Takes responsibility for what it saysAvoids responsibility or assigns it elsewhere
Plans to communicate (invites engagement)Presents information (avoids engagement)
Acknowledges the views of reviewers but maintains tight perspectiveTries to accommodate all views, loses focus
Assumes specific use(s)Assumes generic use (or no use)

Wednesday, May 10, 2006

Another door to my office

When I came to the World Bank in 1998 I was asked not just to improve the quality of the reports being prepared by the evaluation department but to transfer my skills to others. But I was given several handicaps. First, I inherited the job from another editor who had left a legacy of distrust for editors and editorial process. Second, I was working with people from all over the world and, though most had been educated in English, they came from a wide variety of cultural backgrounds and disciplines that had shaped their writing. Most had developed habits common to bureaucratic or academic writing - elaborate and tortuous argument, jargon-laden phraseology, plodding exactitude - all of which was counterproductive to effective communication. Third, the reports produced by these writers had to speak truth to power and get results. This is not your typical editorial assignment.

In the years since then I have developed habits of work that have created trust in the editorial process, given me room to establish standards of writing acceptable to my clients and their readers, and I am proud to say, have contributed to postive developments in the way the World Bank does its work. I have changed the way the evaluation department staff approach the writing task, advanced their use of technology to allow the creation of better-looking, "smarter" documents, and helped create a shared sense of duty to be clear, concise, and straightforward in presenting study results.

My most fundamental editorial principle is nothing to do with writing, it is to be of service. Hence, my door is always open. I am available to answer any question any time. When I have the time, I write down my advice and make it publicly available. While this has been useful, I see the creation of this blog as another door to my office. I will record here what I have to share about writing, grammar, quirks of the English language, the use of Microsoft Word to prepare complex reports, and whatever else may seem appropriate for this forum. I will answer questions. Some of what you find here may be familiar, some commonsense, but I hope above all that what you find here is helpful.