home *** CD-ROM | disk | FTP | other *** search
/ Source Code 1992 March / Source_Code_CD-ROM_Walnut_Creek_March_1992.iso / unix_c / usenet / u_style.txt < prev    next >
Text File  |  1990-10-30  |  4KB  |  106 lines
  1. From sparkyfs!hercules!apple!julius.cs.uiuc.edu!wuarchive!cs.utexas.edu!samsung!xylogics!bu.edu!purdue!spaf Fri Oct  5 08:41:36 PDT 1990
  2.  
  3. Original-from: ofut@gatech.edu (A. Jeff Offutt VI)
  4. [Most recent change: 5  Sep 1990 by spaf@cs.purdue.edu (Gene Spafford)]
  5.  
  6. I would like to take a moment to share some of my knowledge of writing
  7. style.  If you read the suggestions below, remember: it's easy to agree
  8. that they make sense but it's much harder to apply them.
  9.  
  10. References: 
  11.  Cunningham and Pearsall, "How to Write For the World of Work"
  12.  Strunk & White, "Elements of Style"
  13.  
  14. The above references are both excellent books.  Cunningham is a
  15. standard in tech writing classes and won an award for the best tech
  16. writing book from the Association for Teaching of Technical Writing.  I
  17. was lucky enough to take a class from him as an undergraduate.  Strunk
  18. is a standard in college composition classes.  Other ideas here come
  19. from my own experience on the net and hints from other people.
  20.  
  21. This is a "long article." The rest of it is simply a list of pointers.
  22.  
  23.                Writing style:
  24.  
  25.  * Write *below* the readers' reading level.  The avg. person in the US
  26.    reads at a 5th grade level (11 years of age). The avg. professional
  27.    reads at about the 12th grade level (18 years of age).
  28.  
  29.  * Keep paragraphs short and sweet.  Keep sentences shorter and sweeter. 
  30.    This means "concise," not cryptic.
  31.  
  32.  * White space is not wasted space -- it greatly improves clarity.
  33.    A blank line only adds a byte to the article length, so don't be
  34.    stingy if it will help make your meaning clearer.
  35.  
  36.  * Pick your words carefully.  Writing with precision is as important
  37.    here as it is in any other kind of discourse.  Consider carefully
  38.    whether what you have written can be misinterpreted, and whether
  39.    that is something you wish to have happen.
  40.  
  41.  
  42.  * People can only grasp about seven things at once.  This means ideas in a
  43.    paragraph, major sections, etc..
  44.  
  45.  * Avoid abbreviations and acronyms, if possible, and define the ones
  46.    you use.
  47.  
  48.  * There are several variations on any one sentence.  A passive, questioning
  49.    or negative sentence takes longer to read.
  50.  
  51.  
  52.                Net style:
  53.  
  54.  * Subtlety is not communicated well in written form - especially over a 
  55.    computer.
  56.  
  57.  * The above applies to humor as well. (rec.humor, of course, not included.)
  58.  
  59.  * When being especially "flame-boyant", I find it helpful to go to the bathroom
  60.    before actually sending.  Then, I often change the tone considerably. :-)
  61.    Take a break before posting something in anger or that might hurt or
  62.    anger others.
  63.  
  64.  * Subject lines should be used very carefully.  How much time have you
  65.    wasted reading articles with a misleading subject line?  The "Subject:"
  66.    header line can be edited in all the various posting programs
  67.    (as can the "Distribution:", "Newsgroups:" and "Followup-To:" header
  68.    lines).
  69.  
  70.  * References need to be made.  When you answer mail, you have the original
  71.    message fresh in your mind.  When I receive your answer, I don't.
  72.  
  73.  * It's *much* easier to read a mixture of upper and lower case letters.
  74.  
  75.  * Leaving out articles (such as "the," "a," "an," etc.) for "brevity"
  76.    mangles the meaning of your sentences and takes longer to read. It saves
  77.    you time at the expense of your reader.
  78.  
  79.  * Be careful of contextual meanings of words. For instance, I used "articles" 
  80.    just now.  In the context of netnews, it has a different meaning than I 
  81.    intended.
  82.  
  83.  * Make an effort to spell words correctly.  Obvious misspellings are
  84.    jarring and distract the reader.  Every news posting program allows
  85.    you to edit your article before posting, and most systems have some
  86.    kind of spelling checker program that you can use on your article.
  87.  
  88.  * Remember - this is an international network.
  89.  
  90.  * Remember - your current or future employers may be reading your
  91.    articles.  So might your spouse, neighbors, children, and others
  92.    who will long-remember your gaffes.
  93.  
  94. 'Nuff said.  
  95.  
  96. These suggestions are all easily supported by arguments and research.
  97. There's a lot more to say, but....
  98.  
  99. -- 
  100. Gene Spafford
  101. NSF/Purdue/U of Florida  Software Engineering Research Center,
  102. Dept. of Computer Sciences, Purdue University, W. Lafayette IN 47907-2004
  103. Internet:  spaf@cs.purdue.edu    uucp:    ...!{decwrl,gatech,ucbvax}!purdue!spaf
  104.  
  105.  
  106.