COMPUTER SYSTEMS RESEARCH
Elements of Technical Writing
2005-2006

  • Use specific and concrete terms rather than vague generalities When engineers read a brochure or report, they seek detailed technical information - facts, figures, data, recommendations, and conclusions. By its very nature, technical writing must deal in specifics, not generalities.
     Non-specific version:
    
        Aircom's new scrubbing system saves the Samson Company a fortune in fuel every day.
        How?
          By allowing Samson to burn cheap, high-sulfur coal instead of expensive compliance oil, the 
        Aircom Scrubber cuts fuel costs.
          This new system has proved itself efficient.  And reliable.  To find out more, send for 
        our free brochure.
    
    
     More specific version:
    
        With Aircom's new scrubbing system, Samson can burn high-sulfur coal instead of expensive 
        compliance oil and still meet all federal and local emission-control regulations.
           The result is a fuel cost savings of $7,000 a day - a 35 percent reduction in Samson's
        annual fuel bill.
           For over one year, the Aircom system at Samson has demonstrated an on-line availability
        of 98 percent.  And an average SO2 removal efficiency of 92 percent.
           To find out how this commercially proven scrubber can clean the air and cut your fuel
        costs, send for our free brochure.
    
  • Don't be content to say something is good, bad, fast, or slow when you can say how good, how bad, how fast, or how slow. Be quantitative, not qualitative, whenever possible.
    
       He ran fast.    -->   He ran the 100 yard dash.
    
       The sun is hot  -->  The sun is hot - almost 11,000 degrees F at its surface.
    
     
    The words you choose should be specific and concrete:
    
     Non-specific version:
      Our measurements are not precise because the experimental apparatus was in poor condition.
    
     More specific:
      Our weight measurements are not precise because the scale was not working properly.
    
    
     Non-specific version:
      The expedition was delayed for a time because of unfavorable weather conditions.
    
     More specific:
      The expedition was delayed one week because of snowstorms.