TECHNICAL REPORTS WRITING

Slides:



Advertisements
Similar presentations
Module 2 Sessions 10 & 11 Report Writing.
Advertisements

Writing an action research report
Chapter 12 – Strategies for Effective Written Reports
Guide to Computer Forensics and Investigations Fourth Edition
Technical Writing Post Graduate Notes. Course Contents I will select some of the topics described here. A comprehensive group of courses on technical.
EE 399 Lecture 2 (a) Guidelines To Good Writing. Contents Basic Steps Toward Good Writing. Developing an Outline: Outline Benefits. Initial Development.
Computer Engineering 294 R. Smith Writing Skills 03/ Breaking Old Habits Generally we follow old habits. There are hundreds of rules to learn. –
Chapter Section A: Verb Basics Section B: Pronoun Basics Section C: Parallel Structure Section D: Using Modifiers Effectively The Writer’s Handbook: Grammar.
Subject-Verb Agreement and Verb Tense and Verb Form Pasco-Hernando Community College Tutorial Series.
Lecture 3: Writing the Project Documentation Part I
AHSGE Test Vocabulary Language Mrs. Julie Turner School Improvement Specialist Dothan City Schools Dr. Patrick Cain SEHS Assistant Principal Elmore County.
Dr. N. S. Harding Chemical Engineering 477 January 13-14, 2014.
Features of technical writing Personal( I, we) vs impersonal (writer, author), one - ambiguity Passive vs active Clarity- redundant words Nominalization.
MECHANICS OF WRITING C.RAGHAVA RAO.
TECHNICAL WRITING October 31 st, With a partner Write simple “step-by-step” instructions for sending a Kakao Talk message with a phone.
Report Writing Sylvia Corsham De Montfort University 2008/9 (in association with Vered Hawksworth BSc.)
Writing by Design to Craft a Scholarly Paper Fran Racher, RN, PhD School of Health Studies MPN Orientation September, 2011.
Scientific Writing Fred Tudiver, MD Karen Smith, MA Ivy Click, MA Amelia Nichols, MS.
Claire Ridsdale, Teaching & Learning Adviser (Literacy
Report Writing.
Getting the Language Right ITSW 1410 Presentation Media Software Instructor: Glenda H. Easter.
Methodologies. The Method section is very important because it tells your Research Committee how you plan to tackle your research problem. Chapter 3 Methodologies.
Drafting and Revising Effective Sentences Chapter 11 Presented By Blake O'Hare Chris McClune.
Scientific writing style Exact  Word choice: make certain that every word means exactly what you want to express. Choose synonyms with care. Be not.

Report Format and Scientific Writing. What is Scientific Writing? Clear, simple, well ordered No embellishments, not an English paper Written for appropriate.
GE 121 – Engineering Design Engineering Design GE121 Reporting the Outcome Lecture 7A.
Business Communication Workshop Course Coordinator:Ayyaz Qadeer Lecture # 9.
Guide to Computer Forensics and Investigations Fifth Edition
ESL Teacher Networking Meeting Session - 2 Raynel Shepard, Ed.D.
Unit 1 Activity 2B Communication Barriers Report
Preparation of a Research Report Literature review.
Technical Communication A Practical Approach Chapter 17: Style in Technical Writing William Sanborn Pfeiffer Kaye Adkins.
1 Technical Communication A Reader-Centred Approach First Canadian Edition Paul V. Anderson Kerry Surman
Academic Writing Skills: Paraphrasing and Summarising Activities and strategies to help students.
Abstract  An abstract is a concise summary of a larger project (a thesis, research report, performance, service project, etc.) that concisely describes.
1 January 31, Documenting Software William Cohen NCSU CSC 591W January 31, 2008.
Writing Technical Reports
EAP 1540C Advanced Composition 1
Academic writing.
REPORT WRITING.
DPS • English Copyright © 2017 mrshawke.com
Document Development Cycle
Year 6 Objectives: Writing
Technical Report Writing
Writing Selection Items Multiple Choice
Writing Requirements Lecture # 23.
Chapter 7 Report writing
Technical Reading & Writing
Scientific Lab. Reports
Editing for a Professional Style and Tone
Revising and editing Week 3.
REPORT WRITING Many types but two main kinds:
AHSGE Test Vocabulary Language Dr. Patrick Cain
Editing & Polishing your Assignment
A.C.T. English test.
6+1 Traits of Writing Creative Writing.
NOTES OKAY: A separate page per source is okay, if that works for you. But you will have to move the information around eventually. BETTER: A separate.
7.4 | Editing.
A CASUAL CONTRIBUTOR’S LEARNING AID FOR DITA STRUCTURING
Writing reports Wrea Mohammed
Guide to Computer Forensics and Investigations Fourth Edition
Chapter 9 Revising, Rewriting, and Editing
GEE’S Writing RULES.
Copyright © 2010 Pearson Education, Inc.
Guide to Computer Forensics and Investigations Fourth Edition
I write neatly using accurate, consistent handwriting.
TECHNICAL REPORTS WRITING
TECHNICAL REPORTS WRITING
Presentation transcript:

TECHNICAL REPORTS WRITING LECTURE 12 CHAPTER 6 TECHNICAL LANGUAGE

LECTURE 12: TECHNICAL LANGUAGE Grammar Active and passive voice The passive voice is usually used in engineering reports where the writing is intended to be impersonal and objective. A passive sentence uses a form of the verb 'to be' (e.g. 'is', 'was', 'has been', 'will be'), plus the past participle of the verb often made by adding 'ed' to the verb (e.g. 'tasted', 'identified', 'monitored'). The passive voice is preferred when the human subject or agent is less relevant than the activity. In a passive sentence, the human subject is placed last or can be removed from tire sentence.

LECTURE 12: TECHNICAL LANGUAGE Grammar Active and passive voice The active voice emphasizes the human subject or agent by placing it first in the sentence. If no human is directly involvt3d in the action of the sentence (e.g. the subject is a piece of equipment), then it is appropriate to use the active voice. The important issue in the choice between active and passive sentences is placing the key aspect — whether the activity (passive) or the agent (active) — at the beginning of the sentence.

LECTURE 12: TECHNICAL LANGUAGE Grammar Tense of verbs Verb tense changes according to the section in the report, the purpose of the section or sentence and the type of information included. The following suggestions are a general guide only: Use present tense to explain or discuss Continuing objectives General principles or laws Data or results Procedures or instructions

LECTURE 12: TECHNICAL LANGUAGE Grammar Tense of verbs Use past tense (or the past perfect) to state or describe What the objectives were What equipment was used What procedure was followed What happened The review of literature including other research may be written in either the present, past or the present perfect tense. Using the present tense is often less complicated?

LECTURE 12: TECHNICAL LANGUAGE Grammar Agreement between noun and number Nouns need to agree with the number before them. In other words the names of things need to be singular (without an 's') or plural (with an 's') according to whether there is only one or more than one. Some nouns do not use an's' to indicate whether they are singular or plural.

LECTURE 12: TECHNICAL LANGUAGE Grammar Agreement between subject and verb In a sentence, the subject and verb must agree in relation to number and to person. Mistakes with regard to agreement are common when a single subject is separated from its verb by other plural words, causing the subject to appear to be plural when it is not. The following rule helps students to check if they are using the correct verb (it applies when the present tense is used):

LECTURE 12: TECHNICAL LANGUAGE Grammar Agreement between subject and verb if the subject is plural (ends in an 's'), then there is no's' on the verb. If the subject is single (does not end in an 's'), then the verb does end in an 's‘.

LECTURE 12: TECHNICAL LANGUAGE Vocabulary Personal language Currently in engineering reports, personal language is avoided in preference to impersonal constructions which emphasize scientific objectivity. Check with your lecturer before using personal language such as 'I' or 'we'. Personal language is occasionally used to distinguish between the views or findings of other authors and your own. Alternatively, personal language can be avoided by using objective language.

LECTURE 12: TECHNICAL LANGUAGE Vocabulary Gender inclusive language Gender neutral language is language which includes women and men equally. Technical reports should avoid using male-only terminology such as 'he'. This can be achieved by: Using both pronouns Using gender non specific terms Restructuring the sentence to avoid personal pronouns

LECTURE 12: TECHNICAL LANGUAGE Vocabulary Gender inclusive language Another method of being inclusive is to use the plural pronoun 'their' with a single subject when it would not be ambiguous. In the past, this was considered to be grammatically incorrect/ but the University of South Australia's current Policy on Gender Neutral Language (1991) explains that this is now an option.

LECTURE 12: TECHNICAL LANGUAGE Vocabulary Jargon and slang Clear and simple English should be used rather than jargon (specialised or pretentious language). New terms should be defined for the reader. A glossary of terms or abbreviations may be useful for long, complex reports. Informal language or slang should also be avoided. The words which are used should be precise to give an accurate meaning.

LECTURE 12: TECHNICAL LANGUAGE Vocabulary Repetition of words Often writers have favorite words or expressions. Reports should avoid overuse of particular words/ groups of words, or sentence structures. In technical writing, clear expression and attention to detail are essential.

LECTURE 12: CONCLUSIONS While this document was not developed to be an inflexible set of rules, it is however intended to assist university engineering students in producing professional, well organized reports. Student report writing skills can be enhanced by the application of these guidelines in relation to formatting of documents, components, referencing and technical language. Students are encouraged to write with attention to the contents of this Style Guide, but where students instructed should follow the directions given by their lecturers or school.

LECTURE 12: CONCLUSIONS Many resources, such as the library, are available to assist students in their report writing. The use of a specific format or style must be followed consistently throughout a report. By initially planning the presentation of their material, students can concentrate on the content being presented in a report. During the writing and editing process students may find it useful to refer to the Report writing checklist (Appendix H). A well written and logically structured report will result in a quality document which effectively conveys precise information to the reader.

LECTURE 12: RECOMMENDATIONS With regard to the conclusions detailed above, the following recommendations have been formulated. Students are recommended to: Identify and follow instructions from particular Schools or employers — particularly where such instructions vary from common practice. Read and use the information in this Style Guide. Ensure internal consistency in formatting (particularly of numbering and headings). Give attention to visual impact and readability.

LECTURE 12: RECOMMENDATIONS Acknowledge sources by referencing both in the text and in a list at the end Roof read and edits thoroughly all written work. Students should remember that excellent content in a report needs to be supported by high quality presentation, and an accurate use of technical language.