home *** CD-ROM | disk | FTP | other *** search
/ ftp.pasteur.org/FAQ/ / ftp-pasteur-org-FAQ.zip / FAQ / usenet / writing-style / part1 < prev   
Encoding:
Internet Message Format  |  1999-12-29  |  5.3 KB
  1. Path: senator-bedfellow.mit.edu!bloom-beacon.mit.edu!panix!news.gw.com!do-not-use-path-to-reply
  2. Date: Tue, 28 Dec 1999 09:00:21 GMT
  3. Supersedes: <FMMECM.5At@tac.nyc.ny.us>
  4. Expires: Fri, 28 Jan 2000 09:00:21 GMT
  5. Message-ID: <FnG10L.HCq@tac.nyc.ny.us>
  6. From: netannounce@deshaw.com (Mark Moraes)
  7. Subject: Hints on writing style for Usenet
  8. Newsgroups: news.announce.newusers,news.answers
  9. Followup-To: news.newusers.questions
  10. Approved: netannounce@deshaw.com (Mark Moraes)
  11. Lines: 121
  12. Xref: senator-bedfellow.mit.edu news.announce.newusers:4412 news.answers:173786
  13.  
  14. Archive-name: usenet/writing-style/part1
  15. Original-author: ofut@isse.gmu.edu (A. Jeff Offutt VI)
  16. Comment: maintained until 5/93 by spaf@cs.purdue.edu (Gene Spafford)
  17. Last-change: 29 Sep 1997 by netannounce@deshaw.com (Mark Moraes)
  18. Changes-posted-to: news.misc,news.answers
  19.  
  20. I would like to take a moment to share some of my knowledge of writing
  21. style.  If you read the suggestions below, remember: it's easy to agree
  22. that they make sense but it's much harder to apply them.
  23.  
  24. References: 
  25.  Cunningham and Pearsall, "How to Write For the World of Work"
  26.  Strunk & White, "Elements of Style"
  27.  
  28. The above references are both excellent books.  Cunningham is a standard in
  29. tech writing classes and won an award for the best tech writing book from
  30. the Association for Teaching of Technical Writing.  I was lucky enough to
  31. take a class from him as an undergraduate.  Strunk is a standard in college
  32. composition classes.
  33.  
  34.     Editor's note: Thanks to Columbia University, Academic Information
  35.     Systems, Project Bartleby, Strunk can be accessed on the World-Wide
  36.     Web as:
  37.         <http://www.columbia.edu/acis/bartleby/strunk/>
  38.  
  39. Other ideas here come from my own experience on the net and hints from
  40. other people.
  41.  
  42. This is a "long article." The rest of it is simply a list of pointers.
  43.  
  44.                Writing style:
  45.  
  46.  * Make your writing easy to read.  Keep it simple.
  47.  
  48.  * Keep paragraphs short and sweet.  Keep sentences shorter and sweeter. 
  49.    This means "concise," not cryptic.
  50.  
  51.  * White space is not wasted space -- it greatly improves clarity.
  52.    A blank line only adds a byte to the article length, so don't be
  53.    stingy if it will help make your meaning clearer.
  54.  
  55.  * Pick your words carefully.  Writing with precision is as important
  56.    here as it is in any other kind of discourse.  Consider carefully
  57.    whether what you have written can be misinterpreted, and whether
  58.    that is something you wish to have happen.
  59.  
  60.  * People can only grasp about seven things at once.  This means ideas in a
  61.    paragraph, major sections, etc..
  62.  
  63.  * Avoid abbreviations and acronyms, if possible, and define the ones
  64.    you use.
  65.  
  66.  * There are several variations on any one sentence.  A passive, questioning
  67.    or negative sentence takes longer to read.
  68.  
  69.  * "Cute" misspellings are difficult to read, especially if the reader
  70.     is not fluent in the language involved.
  71.  
  72.  
  73.                Net style:
  74.  
  75.  * Subtlety is not communicated well in written form - especially over a 
  76.    computer.  Remember, most people who will read your posting do not
  77.    know you.
  78.  
  79.  * The above applies to humor as well. (rec.humor, of course, not included.)
  80.    Smileys :-), frowns :-(, winks ;-) can sometimes avoid confusion.
  81.  
  82.  * When being especially "flame-boyant", I find it helpful to go to the
  83.    bathroom before actually sending.  Then, I often change the tone
  84.    considerably. :-) Take a break before posting something in anger or that
  85.    might hurt or anger others.
  86.  
  87.  * Subject lines should be used very carefully.  How much time have you
  88.    wasted reading articles with a misleading subject line?  The "Subject:"
  89.    header line can be edited in all the various posting programs
  90.    (as can the "Distribution:", "Newsgroups:" and "Followup-To:" header
  91.    lines).
  92.  
  93.  * References need to be made.  When you answer mail, you have the original
  94.    message fresh in your mind.  When I receive your answer, I don't.
  95.  
  96.  * Do not include the entire article that you are replying to.  Cut down
  97.    the part that you include to the absolute minimum needed to provide
  98.    context to your reply.
  99.  
  100.  * It's *much* easier to read a mixture of upper and lower case letters.
  101.  
  102.  * Leaving out articles (such as "the," "a," "an," etc.) for "brevity"
  103.    mangles the meaning of your sentences and takes longer to read. It saves
  104.    you time at the expense of your reader.
  105.  
  106.  * Be careful of contextual meanings of words. For instance, I used "articles" 
  107.    just now.  In the context of netnews, it has a different meaning than I 
  108.    intended.
  109.  
  110.  * Make an effort to spell words correctly.  Obvious misspellings are
  111.    jarring and distract the reader.  Every news posting program allows
  112.    you to edit your article before posting, and most systems have some
  113.    kind of spelling checker program that you can use on your article.
  114.  
  115.  * If your article goes over one screenful, use subheadings to organize it.
  116.    Numbering your paragraphs is rarely helpful.
  117.  
  118.  * Just before you post your article, re-read it.  This will ensure that
  119.    you actually wrote what you intended to write.
  120.  
  121.  * Remember - this is an international network.
  122.  
  123.  * Remember - your current or future employers may be reading your
  124.    articles.  So might your spouse, neighbors, children, and others
  125.    who will long-remember your gaffes.
  126.  
  127. Enough said.  
  128.  
  129. These suggestions are all easily supported by arguments and research.
  130. There's a lot more to say, but....
  131.  
  132. Jeff Offutt
  133. Copyright 1997, all rights reserved.
  134. Used with permission.
  135.