Technical Writing Course Outline PDF

Document Details

Uploaded by Deleted User

Tags

technical writing report writing communication skills information retrieval

Summary

This document provides an outline for a technical writing course. The course covers various aspects of technical communication, including data retrieval, using visuals, different writing styles, and report formats. It also presents guidelines for effective interviewing and questionnaire design.

Full Transcript

Technical Writing :Course Outline  Chapter 1 : Retrieving Data and Information  Chapter 2 : Using Illustrations & Visual Aids  Chapter 3 : Types of Technical Writing  Chapter 4 : Writing & Editing Instructions  Appendix A : Examples of Technical Writing Types  Appendix B :...

Technical Writing :Course Outline  Chapter 1 : Retrieving Data and Information  Chapter 2 : Using Illustrations & Visual Aids  Chapter 3 : Types of Technical Writing  Chapter 4 : Writing & Editing Instructions  Appendix A : Examples of Technical Writing Types  Appendix B : English Review  Appendix C : Samples of Old Exams Course Contents  Review grammar and mechanics method  Selected texts in the engineering aspects of the training on the speed-reading.  Writing reports Objectives  Transfer of information  Development of communication skills through the discussion and writing. What is Technical Writing? Taking complicated subject matter and transforming it into easy- to-understand information for the reader. Technical Writing The Technical Writing course teaches writers how to prepare letter reports and technical reports about subjects that require technical explanations, diagrams, charts. Technical Writing  Provides clear communication in the workplace  Has unique formats and a specific style of writing Technical Writing  Journal paper  Thesis  Dissertation  Report Getting Started  What?  What type of document are you writing?  Research paper? User guide? etc.  Who?  Who are you writing for?  What do they know?  What do they want to know? Report Format and Organization  Reports generally include these sections in this order:  Abstract  Introduction  Literature Review  Methodology  Results  Discussion  Conclusion A typical lab report includes the following four parts…. - Introduction - Materials and Procedure - Results and Discussion - Conclusions Additional Sections of Lab Reports May Include the Following:  Theory section  Calculations section  Recommendation section  Appendix section What is the size of a Technical Paper ? Page: 210x297 mm, Margins: Top, Bottom: 25.4 mm, Inside: 36mm, Outside: 18 mm, Header: 12.7 mm, Footer: 12.7 mm Using Numbers and Symbols  Measurements  Mathematical Expressions  Percentage  Dates and Clock Time Methods of Retrieving Data and Information 1. Previous Experience 2. Interview 3. Questionnaires 4. Library 5. Internet 2- Interview a) Face-to-Face Interview b) Telephone Interview a) Face-to-Face Interview  A face-to-face interview is the method most widely used in the research of any topic and based on a direct meeting between interviewer and interviewee. - Before the interview  Make sure they understand why you want to interview them and what you will use their information/views for.  Let them know how long the interview should take.  Agree a time and place for the interview – consider a location that is comfortable or familiar to the interviewee b) Telephone Interview  Telephone interviews have become one of the most popular ways to conduct a one on one meeting when geography presents a challenge. 3- Questionnaires  A questionnaire is a research instrument consisting of a series of questions for the purpose of gathering information from respondents - Questionnaires  Determine the Objective  What do you want to ask and of whom?  Consider how the data will be analyzed. What information is needed?  2. Determine the Mode of Administration  Paper and pencil  Cost effective, but low response rate.  Web / E-mail based  Cost effective, higher response rate. Guidelines for writing questions  How many questions?  Find a balance: long enough to obtain the necessary information but short enough so respondents will not lose interest.  Questionnaires that are too long will not be completed  Goal: 25-30 minutes MAX  Keep the vocabulary simple  Avoid double-barrelled questions 4-Library Finding background Information  Dictionaries  Encyclopedias  Handbooks ********************************* 5- Internet Thank You

Use Quizgecko on...
Browser
Browser