4

Click here to load reader

TIPS FOR CLEAR AND CONCISE ENGINEERING …classes.engr.oregonstate.edu/mime/fall2011/ie497/Handouts/writing...Clear and concise engineering writing – p. 1 TIPS FOR CLEAR AND CONCISE

  • Upload
    vutuyen

  • View
    215

  • Download
    3

Embed Size (px)

Citation preview

Page 1: TIPS FOR CLEAR AND CONCISE ENGINEERING …classes.engr.oregonstate.edu/mime/fall2011/ie497/Handouts/writing...Clear and concise engineering writing – p. 1 TIPS FOR CLEAR AND CONCISE

 

Clear and concise engineering writing – p. 1 

 

TIPS FOR CLEAR AND CONCISE ENGINEERING WRITING (with thanks to former OSU Writing Center director Wayne Robertson for much of this handout’s content) 

  1. Shorter is usually better. Eliminate all the unnecessary words, phrases, qualifiers, and 

redundancies from your writing.  

Unnecessarily wordy: it is assumed that a sufficient number of it may well be that are found to be in agreement undertake a study of take into consideration in conjunction with have been shown to be carry out experiments come to the conclusion in order to a proportion of at a later date it would appear that has an ability to a large number of for the purpose of until such time as in connection with I am in the process of we are looking to find in virtually all sectors of society on a regular basis during the month of april on a theoretical level discovered for the first time completely eliminate small in size utilize was met with the approval of the customer in many instances with respect to resembling in nature make an attempt our efforts were achieved at a slow rate

Better: if enough perhaps agree study consider with are experiment conclude to some later apparently can many for until about I am we are seeking almost everywhere regularly in April in theory, theoretically discovered eliminate small use the customer approved often about like try our attempts worked/we succeeded slowly

Page 2: TIPS FOR CLEAR AND CONCISE ENGINEERING …classes.engr.oregonstate.edu/mime/fall2011/ie497/Handouts/writing...Clear and concise engineering writing – p. 1 TIPS FOR CLEAR AND CONCISE

 

Clear and concise engineering writing – p. 2 

 

Wordy: At this point in time we can't ascertain the reason as to why the engine failed in the course of completing the endurance racing competition. Concise: We don’t know why the engine failed during the endurance race.   Wordy: Indeed, it could be said that personal advancement in life lies in an individual’s ability to say the right kind of words in the right way at the right moment in time. Concise: Indeed, personal advancement depends on one’s ability to say the right things in the right way at the right time.   Wordy:  The purpose of these general notes is first to assist authors in the writing of technical reports in an acceptable style and secondly to suggest the introduction of greater uniformity in the general approach to the preparation of technical papers for publication.  Concise: These notes will help authors write technical reports in an acceptable style and encourage uniformity in report presentation.    Wordy: After reviewing the content of your senior design report, and in light of other relevant findings that have been made independently of your study, there is ample evidence for making important, significant changes to our operating procedures. Concise: The content of your design report and other relevant findings support the need for significant changes in our operating procedures.  This example was adapted from the Purdue Online Writing Lab “Concise Writing” handout at http://owl.english.purdue.edu/owl/resource/635/01/ (accessed 10/02/07). 

 2. Place your subject and verb as close together as possible. Short modifiers are acceptable, 

but longer ones make sentences hard to read.   

Weak: The principal objective of mechanics of materials, which is a branch of applied mechanics that deals with the behavior of solid bodies when being subjected to various types of loading and that is also known as strength of materials and mechanics of deformable bodies, is to determine the stresses, strains, and displacements in structures and their components due to the loads acting on them. 

Page 3: TIPS FOR CLEAR AND CONCISE ENGINEERING …classes.engr.oregonstate.edu/mime/fall2011/ie497/Handouts/writing...Clear and concise engineering writing – p. 1 TIPS FOR CLEAR AND CONCISE

 

Clear and concise engineering writing – p. 3 

 

 Improved: Mechanics of materials is a branch of applied mechanics that deals with the behavior of solid bodies subjected to various types of loading.  Other names for this field of study are strength of materials and mechanics of deformable bodies. Its principal objective is to determine the stresses, strains, and displacements in structures and their components due to the loads acting on them.  (This example adapted from Gere, James M.,  Mechanics of Materials, 5th ed., Pacific Grove, CA: Brooks/Cole, 2001, p. 1.)  

  3. Avoid overusing passive voice. The reason for using passive voice is to emphasize the 

object and downplay the agent. Engineers and scientists often use passive voice when describing experimental or design processes because in these situations, what was done is more important than who did it. But passive voice is not always the best solution. It should not be used, for example, when addressing sources or when the agent is important. 

 Weak: An increased elasticity was manifested by all three composite materials as a result of the test. Improved: The elasticity of all three composite materials increased under test conditions.  Weak:  In the case of the fourth process, however, a problem is presented which is difficult. Improved: The fourth process, however, presents a difficult problem.  (This example comes from Douglas Scott’s “The Inhuman Style,” a landmark essay on technical writing that appeared in the February 1962 issue of Technology Review.)   

Weak:  In this project, a series of laboratory and field tests was performed by our design team so that performance issues related to the proposed design changes could be identified and resolved.  Improved: In this project, our design team [or “we”] performed a series of laboratory and field tests to identify and resolve performance issues related to the proposed design changes.    

Page 4: TIPS FOR CLEAR AND CONCISE ENGINEERING …classes.engr.oregonstate.edu/mime/fall2011/ie497/Handouts/writing...Clear and concise engineering writing – p. 1 TIPS FOR CLEAR AND CONCISE

 

Clear and concise engineering writing – p. 4 

 

4. Avoid nominalizations.  Nominalization is the act of turning verbs into nouns unnecessarily. Remember that verbs are easier for readers to understand AND they add life to your prose. (This is one easy way to add vigor to technical writing.) 

 Weak:  We conducted a tour of the manufacturing site. Improved:  We toured the manufacturing site.   Weak:   Additional consideration should be given by XYZ Company to a possible redesign of its quality assurance processes.  Improved:   XYZ company should consider redesigning its quality assurance processes.   Weak:  The ME 383 team presented a demonstration of the second law of thermodynamics to the students in the 7th grade science class. Improved: The ME 383 team demonstrated the second law of thermodynamics to the 7th grade science class. 

  5. Vary your sentences and sentence introductions. Short sentences are good for introducing 

and summarizing ideas. Longer sentences are good for giving details and complicated information. 

  6. Beware of idiomatic expressions. Not only do idiomatic expressions feel informal, they also 

make prose less exact and more difficult for readers to understand.  Idiomatic expressions are especially problematic in texts directed to international audiences, which in today’s global workplaces are…well…par for the course.  

 Examples: Acid test A different ball game Beat around the bush Break new ground Face the music Flash in the pan Horns of a dilemma Get on board 

In the pipeline Look a gift horse in the mouth Luck out Needle in a haystack Open‐and‐shut case Right off the bat See the light at the end of the tunnel  Work like a dog