A Lightweight Look at Technical Writing

This page is for students enrolled in the Spring 2006 Technical Writing Raytheon in-house course.

 Course Info

 Course Outline

 Links 

 Instructor 

 Prerequisites

 Exercise

 Homework

Goals:

To improve the quality of our technical writing.

Class Schedule:

Six one-hour meetings, Wednesdays at noon, starting Wednesday 10 May 2006. Building B1, Room S827. (Computer training room on North side of the building). Each hour attended counts towards training time. Roll is taken via a sign-in sheet) at every class, and your attendance is recorded in the training database.

Text:

Spring Into Technical Writing, Barry Rosenberg, Paperback, Addison Wessley, 1st edition, Published May 2005, 336 pages, ISBN 0-201-70353-X. The book is intended for busy engineers and scientists who need to improve their writing skills in the workplace. It is divided into "chunks" with examples for easier comprehension. The book covers a surprisingly broad range of topics, including emails, power point presentations, and web pages, as well as the more ordinary topics of lab reports, white papers, technical manuals, proposals. This book is provided to enrolled students at company expense.

You should consider obtaining a copy of The Elements of Style by Strunk and White. This classic is available at any bookstore for under $10. ISBN 0-205-30902-X. Available as a pocket-sized paperback, the book is now in its fourth edition, having first been published over eighty-five years ago. An online version of the first edition is available.



 

If you're curious about the English language in general, I suggest The Story of English, McCrum, Cran and MacNeil, ISBN 0-142-002313. This fascinating book is easy to read, with many maps and illustrations. Originally brought out as a companion book to a PBS Series on the English language, it is in its third edition and available in paperback for around $10.


 

Here's a highly regarded, recent book on graphics. Show Me the Numbers, ISBN 0970601999.

 

 

 

This is a book by the most notable expert in the field, Edward Tufte. The Visual Display of Quantitative Information, ISBN 096139210X. Tufte has authored many books on the subject and has a website. It's Tufte who considers Charles Minard's map of Napolean's retreat from Moscow in 1812 as the best statistical graphic ever drawn.

 

 

 

Another, invaluable publication is the Raytheon Style Guide, version 1.4, September, 2005. Developed by the Raytheon style council, and updated quarterly, the guide provides a reference for writing at Raytheon. The guide is a supplement to the Associated Press Stylebook. The great value of the guide is the treatment of topics specific to Raytheon and to the defense business. You can download the guide from the company intranet, at the Corporate Identity section. Start with the Corporate Identity & Branding Quicklink at the left-hand side of the intranet home page. Then follow the Writing for Print and Web link on the Corporate Identity page. You'll find templates, letterheads, logos, and a host of other information on this page.

Instructor:

Robert G. (Bob) Hayes, Senior Principal Software Engineer, Raytheon Vision Systems. Bob has been designing software systems at Hughes Aircraft/Raytheon for 30 years. He holds a BSE in Electrical Engineering and an MS in Computer Science. Bob has authored or co-authored many technical papers for publication internally at Hughes/Raytheon, as well as professionally, including the best paper at the 2000 IEEE System Readiness Conference.

Prerequisites:

None, other than a desire to learn how to write well. If you don't want to write well, you won't. The only way to really learn/understand a topic is to spend time with it. Expect to do exercises in class and on your own. Working together on exercises in class is allowed and expected.

To gain perspective on the nature of technical writing, you might try reading some non-technical writing of contrasting styles. Ernest Hemmingway won the Nobel Prize in literature for his short, declarative sentences and terse prose. The novella The Old Man and the Sea is perhaps his best known work and you can read it in a couple of hours. Contrast Hemmingway's efficient style with Revolt in the Desert by T.E.Lawrence (Lawrence of Arabia). Lawrence is known for his Oxford style, which is anything but terse and efficient. Of these two styles, which do you imagine is most like good technical prose?

 

Links:

Here are some useful links. There is an immense amount of information on technical writing available on the web, including complete texts and courses.

Official website of the class text

National Review An example of literate prose from a notable intellectual.

http://www.io.com/~hcexres/textbook/ An on-line textbook on Technical Writing

http://www.rbs0.com/tw.htm Thoughts on technical writing from a EE professor

http://www.technical-writing-course.com/ A short technical writing course.

Columbia University Technical writing style according to Columbia.

http://www.techpubs.com/resources.html Resources for technical writers

http://www.klariti.com/technical-writing/index.shtml Articles and tutorials on Technical Writing.

Virginia Tech A nice site on technical writing that includes exercises.

Rensselaer Writing Center at Rensselaer.

Associated Press Stylebook A well-respected style guide and the basis for the Raytheon Style Guide.

Elements of Style An on-line version of famous style guide by William Strunk and E.B.White (1st ed.)

Tech writing quotes Pretty funny.

OWL Purdue's take on technical writing.

Mayfield Handbook of Technical and Scientific Writing Seems like good stuff.

Edward Tufte Notable expert on graphical portrayal of quantitative information.

Email Replies A site on email etiquette.

Email netiquette What Yale thinks about email.

PowerPoint FAQ Start here for info on PowerPoint.

PowerPoint is Evil Edward Tuft's take on PowerPoint.

Gettysburg Address in PowerPoint More PowerPoint bashing

Harvard's PowerPoint Guidelines How Harvard thinks PowerPoint slides should look

Microsoft's PowerPoint homepage From the horse's mouth

 

Back to top

Course Outline:

We'll generally follow the following outline, though we may diverge from it or even omit certain topics altogether.

 

Back to top

Homework:

Let's try a simple project. Everyone masters tying their own shoe laces by the age of five years or so, usually under the guidance of a parent, teacher, or older sibling. Suppose you had to teach someone how to tie a shoelace with written instructions, with no illustrations? Is this hard to do? Try writing a one page document describing how to tie a shoelace.

Back to top

 

 An Exercise:

How many of these terms can you define? Why do we care if we know the meaning of these terms? If we learn the meanings of these, we'll be able to understand rules of grammar and usage that are associated with them.

Gerund

Predicate

Verb

Transitive

Participle

Tense

Perfect tense

Pluperfect tense

Pronoun

Clause

Adverb

Adjective

Proper noun

Direct object

Indirect object

Intransitive

Conjunction

Preposition

Infinitive

Split infinitive

Dangling participle

Phrase

Fragment

Jargon

Noun

Person

Number

Auxiliary verb

Past perfect

Future perfect

Voice

Active voice

Passive voice

Series

Plural

Singular

Present

Past

Future

Parenthetic expression

Slang

Case

Subjective case

Possessive case

Possessive pronoun

Reflexive pronoun

Compound sentence

Syntax

Grammar

Object of the preposition

Verbal

Subordinate clause

Colloquialism

Complement

Article

Clause

Contraction

Modifier

Nonrestrictive modifier

Restrictive modifier

Nominative pronoun

Prepositional phrase

Agreement

Antecedent

Appositive

Modal auxiliaries

Main clause

Dependent clause

Relative pronoun

Subordinate clause

Parallelism

Imperative verb

Punctuation

Pace

Sidebar

Callout

Tone

Metaphor

Parsimony

Simile

Analogy

Loose sentence

Transition

 

 

Back to top

Last Revised: 24 April 2006
Copyright
Ó 2005 Robert G. Hayes.
e-mail the webmaster: rghayes at earthlink dot net
   

You are visitor number

 

Best viewed at 1024x768 or better!
I'm not responsible for your poor resolution!
Pump it up!