1 / 24

Lecture 10 - Effective Technical Writing

Engineering 102 . Lecture 10 - Effective Technical Writing. Administration. Solar Oven Predictions Model HW due tomorrow night Pick up your team’s oven supplies by tomorrow Solar Oven testing on Tuesday, Mar. 8 Meet on the mall by the cactus garden (NOTE: this is a location change!)

toby
Download Presentation

Lecture 10 - Effective Technical Writing

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Engineering 102 Lecture 10 - Effective Technical Writing

  2. Administration • Solar Oven Predictions Model HW due tomorrow night • Pick up your team’s oven supplies by tomorrow • Solar Oven testing on Tuesday, Mar. 8 • Meet on the mall by the cactus garden (NOTE: this is a location change!) • Bring your team’s oven and thermometer • Solar Oven Presentations Mar. 22 & 24

  3. Administration, cont. • SolidWorks Homework (individual) due Mar. 8 (Part 1, “30 minute Tutorial”) and Mar. 11 (Part 2, other 3 tutorials) • Submit files as pdfs to D2L dropboxes (NOT SolidWorks files!) • SolidWorks Tutors in OSCR lab now through Mar. 11 • Installing SolidWorks on your own computer is optional

  4. Administration, cont. = Lab open and SolidWorks tutor(s) there = Lab closed = Lab open, but no SolidWorks tutor

  5. Agenda Explore Technical Writing topics • Your final solar oven report is the largest single component of your course grade!

  6. Effective Written Communication • The ability to communicate effectively in writing remains a critical skill in business and industry • Particularly for engineers, who often need to communicate complex information to non-technical professionals

  7. Effective Written Communication • Survey (Richard M. Davis, USAF) • Engineers spend 25% of work week doing what? Writing • Survey (College of Engineering, Univ. of Wisconsin) • 9,000 professional engineers: most useful subject in college = Writing • Survey (College of Engineering, Virginia Tech) • Recruiters: top attribute engineers need to improve = Writing Source: http://www.writing.engr.psu.edu/handbook/visuals.html

  8. Before Writing • Consider your audience • Needs • Level • Scope • Determine your purpose • Have a plan • Outlines are your friend • Start early and rewrite often • Allow time for editing & revising

  9. Basics of Excellent Writing

  10. Precise Original: “The project was a success.” Improved: “The project was successful because all of the design requirements were met and the company improved its market position.”

  11. Concise Original: “It would be appreciated if you would kindly notify the company of any anticipated changes by September 1, 2011.” Improved: “Please notify us of any changes by September 1, 2011.”

  12. Clear Original: “The problem was fairly significant.” Improved: “The problem occurred three times in forty attempts.”

  13. Clear Original: “The decision will be based on several important considerations.” Improved: “The decision will be based on performance, cost, and reliability.”

  14. How to write clearly • Include statements that are simple and to-the-point • Express a single thought in each statement • Avoid long sentences; break into two sentences as needed • Use consistent terminology • Use consistent tense

  15. Avoid jargon, acronyms, and puffery Original: “Please include the apropos documentation on the ICR.” Improved: “Please include the appropriate documentation for the Interpretive Chronology Report.”

  16. Use Formal language Original: “The final cut will be made on January 31, 2011.” Improved: “The participants for the project will be selected on January 31, 2011.”

  17. Consistency Original: The team ground rules include: • attend meetings regularly • arrive on time • treating fellow teammates with respect is essential Improved: The team ground rules include: • attend meetings regularly • arrive on time • treat fellow teammates with respect

  18. No “Wall O’ Text” This paper describes a battery charger having a reverse-polarity protection for vehicles. In this battery charger the positive terminal connector of the battery is directly connected to the positive terminal connector of the generator. The negative terminal connector of the generator is connected to ground, as is the negative terminal connector of the battery. If the battery in such a system is connected to the generator using the wrong polarity, there is the risk that a high short-circuit current will flow via the diodes provided to rectify the generator power output, thereby destroying them and possibly additional components of the system as well. To prevent this, at least one direct-current terminal connector of the generator is assigned a reverse-polarity protection device, which includes a fuse, which melts if the battery is connected to the direct-current terminal connectors of the generator with reverse polarization and which interrupts the short-circuit current. The fuse can be connected via a supplementary diode, so that even during the blow-out of the fuse no short-circuit current will run through the load-rectifier set.

  19. Avoiding “Wall O’ Text” • Paragraphs • Figures, charts, graphs, tables, other graphics • Headings and sub-headings

  20. Tables, Charts, and Graphics • Must stand alone! Include labels and captions • Always mention in text before inserting the figure • Avoid the temptation to make them complicated; no unnecessary frills • Color promotes understanding • But use color sparingly

  21. Remember the Details! • Include a Title Page • Include all Team Member names & the date on the Title Page • Include a Table of Contents & page numbers • An introductory paragraph, executive summary, or abstract is a great way to provide your reader with a summary of your report

  22. Remember the Details! Cont. • Don’t forget to spell check • Keep your fonts consistent throughout the report • Don’t choose a fancy font; keep it standard and simple • San serif fonts are a good choice • Include references and appendices as needed

  23. Technical Writing Homework • Do this before you begin to write your final Solar Oven report • On D2L Content, open “Writing Guidelines for Engineering and Science Students” • Explore the various pages • Take the Grammar, Punctuation, and Usage Skills Tests • Don’t be surprised if you see some of this material on Midterm #2…

  24. Conclusion • Solar Oven Predictions Model HW due tomorrow night • Pick up your team’s oven supplies by tomorrow • Solar Oven testing on Tuesday, Mar. 8 • Meet on the mall by the cactus garden (NOTE: this is a location change!) • Bring your team’s oven and thermometer • SolidWorks HW (2 parts, individual) due next week • Solar Oven Presentations Mar. 22 & 24

More Related