Effective Technical Writing (TM236)

SynopsisIndividuals who receive, edit, or prepare technical documents are involved in an information transaction between themselves and their readers. Typically, technical contributors are not aware of how to write technical documents, nor are they informed about the technical document standards defined by their company, if any. This course will teach you proven technical writing approaches and techniques that you can apply to your work. It is tailored towards helping technical contributors, such as engineers or technicians, to successfully convey their message to their target audience.  Strategies for preparing technical documents, as well as an understanding of the structure and style of a technical document, are also presented in this course.

Effective communication in a company can lead to substantial cost savings when information is conveyed clearly and accurately. Good technical writers are able to turn information into knowledge to help their readers understand complex ideas and make educated decisions. Follow the principles and guidelines of this workshop to produce clear and effective writing.

What previous participants say about this course
Answers to the question 'what did you like most about the course'

• "The details, corrections on what people usually do wrong. A lot of examples. Participation of the attendees" - 13 Mar 10
• "The way the instructor convey his message/knowledge" - 13 Mar 10
• "The game" - 27 Mar 10
• "Technic how to make a good report" - 27 Mar 10
• "Everything" - 27 Mar 10
• "Most common mistakes in technical writing" - 27 Mar 10
• "The exercises given by instructor, easy, simple, interesting" - 27 Mar 10
• "Improve my knowledge. The instructor taught a lot of information about technical writing that I don't know" - 27 Mar 10

What You Will LearnParticipants will learn how to:

• structure and write technical documents that are precise, clear, and concise
• create meaningful content that can be understood and used
• persuade readers to accept or act on your proposals
• instruct readers to accurately follow your procedures

Who Should AttendManagers, engineers, and technicians who need to write, edit, or evaluate technical documents.

Prerequisite

• Good command of English
• Technical background (diploma and above)

Course MethodologyThis course is presented in a workshop style, with exercises and case studies to illustrate the concepts taught. It is an experiential learning workshop where emphasis is placed on your participation in practicing the skills taught.

Course Duration2 days, 9am to 5pm

Course StructureModule 1  Introduction

• Types of communication
• Attributes of technical writing
• Purposes of technical writing
• Benefits of technical writing
• Aspects of technical writing

• Exercise: Writing for different audiences

• How to create meaning out of data
• How to design a high-quality technical document

• Types of technical documents
• Typography of documents
• Layout of documents
• How form influences perception of your technical document
• Employing good practices of grammar
• Employing good practices of punctuation
• Exercise: Role-play a copy editor

• Six goals of Technical Writing

• Organization of a Technical Document

• Guidelines for illustrations:

• Exercise: Descriptive and informative summaries
• Exercise: Case study on the logical strategies for technical content