home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1993 #3 / NN_1993_3.iso / spool / misc / writing / 4238 < prev    next >
Encoding:
Text File  |  1993-01-23  |  1.7 KB  |  46 lines
  1. Newsgroups: misc.writing
  2. Path: sparky!uunet!zaphod.mps.ohio-state.edu!sdd.hp.com!sgiblab!pacbell.com!att-out!cbfsb!cbnewsg.cb.att.com!djd
  3. From: djd@cbnewsg.cb.att.com (david.j.daulton)
  4. Subject: Rules of Thumb
  5. Message-ID: <1993Jan23.052009.13460@cbfsb.cb.att.com>
  6. Sender: news@cbfsb.cb.att.com
  7. Organization: AT&T
  8. References: <1jnfejINNkg3@usenet.INS.CWRU.Edu> <1993Jan22.231853.34535@datamark.co.nz>
  9. Date: Sat, 23 Jan 1993 05:20:09 GMT
  10. Lines: 34
  11.  
  12. As a technical writer I have a few of my own rules of thumb.  In no
  13. special order...
  14.  
  15. 1.  Use "for example" a lot.
  16.  
  17. 2.  Use the product.  Writing from engineers' explanations is fiction.
  18. Writing from project requirements is fantasy.
  19.  
  20. 3. When you inherit a new project, "grep" for "that" and "which" and correct
  21. them.
  22.  
  23. 4. Read Strunk and White once a year.
  24.  
  25. 5. Keep returning to your sources until you understand. If you don't understand
  26. something, there is vanishing little chance you can explain it.   
  27.  
  28. 6.  Cut the crap.  Does the reader NEED this word?  No?  Cut it.  Does the
  29. reader NEED this sentence?  No?  Cut it.  This chapter?  This manual?
  30. Cut, slash, chop.  Information buried is information lost.
  31.  
  32. 7.  Think of your reader continually, and talk to him or her through what you
  33. write. 
  34.  
  35. 8.  Use personal pronouns, active voice, and try to rewrite "being" verbs out
  36. of your sentences.
  37.  
  38. 9. End sentences with prepositions, split infinitives, and so on, as needed
  39. in order to sound natural.  This requires you to know grammar well enough so
  40. that when an engineer changes "use" to "utilize", or whatever, you can
  41. politely (and with good humor) explain that he is full of ....
  42.  
  43. 10.  Remember that you are really an ANTI-technical writer.
  44.  
  45. 11. NEVER rewrite.  No, wait, where'd that come from?  Heinlein who?
  46.