Quantcast
Channel: Kevin Purcell's posterous blog
Viewing all articles
Browse latest Browse all 20

Combine journalism with the technical report format to make engineers write concisely with sentences?

$
0
0

On the thread following Edward Tufte's article PowerPoint Does Rocket Science--and Better Techniques for Technical Reports which shows a small part of his book Beautiful Evidence.

There is this interesting comment on a suggested way to write techbical reports.

How to make engineers write concisely with sentences? By combining journalism with the technical report format. In a newspaper article, the paragraphs are ordered by importance, so that the reader can stop reading the article at whatever point they lose interest, knowing that the part they have read was more important than the part left unread. 

State your message in one sentence. That is your title. Write one paragraph justifying the message. That is your abstract. Circle each phrase in the abstract that needs clarification or more context. Write a paragraph or two for each such phrase. That is the body of your report. Identify each sentence in the body that needs clarification and write a paragraph or two in the appendix. Include your contact information for readers who require further detail.

-- William A. Wood (email), September 8, 2005

This merger of a journalistic or news style of writing, using an inverted pyramid organization attempting to answer The Five Ws (are there more Ws in a technical report?) and perhaps using a head, subhead, lead and nut graph to organize the writing, placing the most important ideas first with a technical report style.

I guess this contrasts with the more usual whodunnit style that strives for a reveal at the end of the report but in the meantime keeps everyone in the dark and perhaps throws out the odd red herring.

Permalink | Leave a comment  »


Viewing all articles
Browse latest Browse all 20

Trending Articles


FIAT 110 NC 115 B kiper