<DrumBeat: July 28, 2007The Oil DrumDrumBeat: July 29, 2007>

21 comments on Charlie Hall's New Book, Udall and Bartlett on the NPC Report, and a New FAQ

Comments can no longer be added to this story.

bart on July 28, 2007 - 5:37pm Permalink | Subthread | Comments top

Nice job with the Reader Guidelines.

Anything that increases the quality of discussion is a big plus.

Any thought about "Writer Guidelines"? Following a few basic rules would boost the readability of many posts. For example:

  • Keep paragraphs short, especially the first few paragraphs. Long paragraphs intimidate readers, especially on the Web.
  • The first part of the post should tell what is to come - don't plunge right into graphs and statistics.
  • The last part of the post should summarize your points and give a take-away message
  • The best posts develop their ideas logically according to a plan. Following an outline can help keep you on track.
  • Whenever you make a highly technical point or cite an equation, provide a translation in everyday language for the non-engineers.
  • The first time you use an acronym, spell it out.
  • Use sub-heads and lists (numbered and unnumbered) to break up the text.
  • Prefer short sentences and active voice (avoid the passive).
  • Write headlines (article titles) that are meaningful.

These points are standard practice for technical writers and journalists. I've noticed that engineers and other technical professionals vastly improve their writing when they follow these guidelines.

Bart
Energy Bulletin

0
Comments can no longer be added to this story.
ThatsItImout on July 29, 2007 - 3:49am Permalink | Subthread | Parent | Comments top

bart,

Those aren't bad, but what about some of us guys who have a tendency to write more in the mode of the humanities types, sociologists or philosophers
(ever try to read Pitirim Sorokin, Arnold Toynbee, or Marshall McCluhan?), that is to say long, circular, but thoughtful (often to a fault?) :-)

Anyway, I live by the rule of James Joyce...
"I demand nothing of my readers but they devote their life to the study of my work." :-)

Roger Conner Jr.
Remember, we are only one cubic mile from freedom

0
Comments can no longer be added to this story.
bart on July 29, 2007 - 1:41pm Permalink | Subthread | Parent | Comments top

Well, you're right, Roger. You can't legislate poets.

However, if you are writing to communicate, there is a standard set of guidelines. One won't get very far in journalism, PR or technical writing without them.

Even in the fields of humanities and the social sciences, they should be the norm unless one has an overwhelming reason to write otherwise. The Joyces are rare in literature; the Hemingways are the majority.

Some of the best models are the scientists and philosophers of the past, who prided themselves on a clear, elegant style.

If we want to get the message out, we should follow their lead.

Bart
Energy Bulletin

0
Comments can no longer be added to this story.