Showing posts with label concision. Show all posts
Showing posts with label concision. Show all posts

Sunday, March 13, 2011

Forcing the reader, or Less, better?

As I noted earlier, I'm taking another run at Hannah Arendt's book of political philosophy, "The Human Condition". I bought this book almost 40 years ago and periodically (like, every 10 or 15 years) try reading it. For whatever reason, this time I'm "getting it" and am about half-way through. I'll freely admit that this book is at the outside edge of "stuff I can understand" and I sympathize with people who have started the book and abandoned it.

Reading some of the more negative reviews of the book on Amazon.com, I notice a comment that I've seen on other "difficult" books: That the author's style is too verbose. It's a mystery to me how something complicated could be explained better with fewer words. And the reviewer's belief seems to be a common one: Many of the participants in my technical writing course list "writing more concisely" as one of their goals in taking the course.

But I think that this belief is part of  a "cult of conciseness": Concision for its own sake/shorter is always better. Much of this cult can be traced back to "The Elements of Style" and the Plain Language movement. Both of these sources attacked unnecessary words. But, in both of these sources, "conciseness" was not an end in itself (or shouldn't have been)--concision was a means to an end: clearer writing.

Certainly, many writers add lots of unnecessary words--usually modifiers that add no value ("to be done weekly, every seven days,..") or stock phrases ("at this point in time" vs. "now"). And, yes, I also recognize readers are discouraged by long documents so a shorter document is more likely to be read. But the length of the document should be tailored to the readers' needs, not to any arbitrary standard of conciseness.



I do acknowledge that, when a reader is confused, more words won't necessarily help. I'll even acknowledge that my usual solution to confusion--more examples--may not help. But it's not the number of words that is the problem: It's the word choice that matters. The words have to be the right words for the reader and the examples have to be relevant to the reader and germane to the topic.

As an example: I did a technical talk once on Structured Query Language where, using the intialism (SQL) as an acronym, I kept referring to the topic as "sequel." This is an accepted pronunciation in the field, as is sounding out the initialism: ess-cue-ell (in writing, you can often tell which the author uses by looking at the articles: does the author write "an SQL statement" or "a SQL statement"). However, at least one person in the audience for this talk didn't know the "sequel" pronunciation and commented, after my talk, that it was fifteen minutes into my presentation before he knew what I was talking about. Whatever benefits my concision gained (using the single word--sequel--versus the longer, full term or the spelled out initialism) was lost on this participant. Now, when I talk about this topic, I switch between "Structured Query Language", ess-cue-ell, and sequel.

As technical writers our goal is to successfully explain things, to support the reader doing something or making a decision that they would not otherwise be able to do (or do as well) without our help. We should use as many words as required for the audience, their scenario, and our purposes...and then stop. Do the words add value? Leave them in; Otherwise, throw the bums out. And, if you go back to both "The Elements of Style" and the Plain Language movement, you'll find that's their story also.


Concision falls out of doing the right thing for your audience. It's not a separate, parallel process.

And if our reader doesn't need our help (or will never read our documents) then we shouldn't write at all. Now, that's concision.


Reading or read

Tuesday, September 29, 2009

Concision, or Nothing

One of the most frequent requests that I get from participants in my technical writing courses is that they want their writing to be concise. They seem to be confident that concision is an absolute: it's always better to be shorter.

To a certain extent, I agree. There are many phrases that roll off of our tongues that have no meaning and contribute no value to the reader. My earlier column on meta-talk was about unnecessary words, for instance. For most of these glorious phrases, there is a shorter (more concise) phrase that says the same thing though it sounds much plainer:
"At this point in time" ---> "now"
"In the matter of x" ---> "About x"
Some of these glorious phrases can be eliminated altogether: Nothing needs to be said at all.

Perhaps the best candidate is "Note that" as in "Note that you must turn on the water." I've edited several articles where, it seemed, every second paragraph began with "Note that". At best, "Note that" is the wordier version of the exclamation mark: Use it too often and it loses its meaning (I tell authors that they get--at most--one exclamation mark per article: use it wisely).

But I don't think that approach goes far enough: Unlike the exclamation mark, "Note that" is never appropriate and usually offensive. "Note that" points out the egoism of the author. It suggests that (a) the reader is incapable of noticing the importance of what the author is about to say and will not put the appropriate value on it, and (b) that if the author says that the following information is important then that's all the direction that the reader needs to establish the value of the information. Rather than try to impose his or her (or its) will on the reader, the author is far better off to omit "Note that", tell the reader why this particular fact is important, and let readers draw their own judgments.

Of course, that strategy will require more words than just "Note that." This is where the argument for concision falls down. The goal is not to use the fewest words possible; the goal is to cover all of what the audience needs....and then stop writing. Not just write in fewer words--stop writing altogether. It's "concision of content" that matters first; "concision of individual words", while certainly worthwhile, is (relatively) unimportant.

Reading or read