Technical Writing Presentation

Introduction to Technical Writing

• Importance of technical writing in engineering

  • Essential skill for current coursework and future engineering roles

  • Communicates ideas and results effectively.

Perception of Communication

• Example: An email with grammatical/spelling errors from a highly qualified individual.

  • Conclusion by the recipient: Perceived as sloppy and careless.

  • Importance of careful communication to maintain professional image.

Why Tech Writing Matters

• Engineers are not just problem solvers, but also communicators.

• Good communication skills lead to career advancement (higher salaries, promotions).

• Bad writing can undermine smart engineering capabilities.

Structure of Effective Communication

• Elements of a good report:

  • Letter of endorsement

  • Table of contents

  • Introduction

  • Organized ideas and questions.

• Common pitfalls: important information gets buried.

Modern Communication Challenges

• Shift from formal communication to instant messaging styles (e.g., Snapchat, text).

• Written communications can have lasting impacts (e.g., potential legal issues).

• Importance of maintaining a professional digital footprint (e.g., social media presence).

Audience Awareness in Presentations

• Importance of understanding the audience.

• Tailoring presentations to meet the interests and concerns of the audience.

• Example from experience: The need to connect project benefits to the audience’s priorities.

Pre-Writing and Planning

• Emphasis on pre-writing: spend up to 70% of your time brainstorming and organizing ideas.

• Importance of structuring technical documents before writing.

• Example from thesis writing: planning chapters and subsections before drafting.

Structuring Reports and Presentations

• Key components:

  • Introduction

  • Main content with clear transitions

  • Conclusion summarizing key points.

• The three-point rule for retention: keep key messages to two or three points for clarity.

The Writing Process

• Phases:

  • Pre-writing: brainstorming, planning, and organizing.

  • Drafting: writing complete sentences after planning.

  • Revising: getting feedback and ensuring clarity.

• Importance of readability and understanding audience engagement during presentations.

The Four S's of Writing

• Keep it Short, Simple, Strong, and Sincere.

• Precise language is paramount: avoid acronyms and jargon when possible.

• Use active voice in writing for clarity and impact.

Language Tips for Effective Writing

• Focus on clear, concise sentences:

  • Remove unnecessary words.

  • Keep verb tenses consistent.

• Use strong and specific verbs to enhance clarity.

• Avoid turning verbs into nouns (e.g., "innovating").

Common Mistakes to Avoid

• Avoiding legalese and jargon to maintain clarity.

• Ensuring multiple ideas are not jammed into a single sentence.

• Dividing complex paragraphs into manageable ideas for better understanding.

Visual Clarity in Communicating Data

• Importance of presentable figures and tables.

• Ensure that visual aids contribute to understanding without causing confusion.

Citing Sources and Professional Formatting

• Importance of citing sources to avoid plagiarism.

• Suggested formatting: single line spacing for titles, double line spacing for text, 1 inch borders, and page numbers in the footer.

Writing Resources

• Online tools for improving writing:

  • Ace plagiarism checker

  • Purdue Online Writing Lab

  • Institution of Engineering and Technology resources.

Conclusion

• Importance of thoughtful and organized technical writing.

• Encouragement to apply learned skills and improve writing practices.