Objectives in Technical Writing

Slides:



Advertisements
Similar presentations
Effective Communication: Seven Cs
Advertisements

Construction of Clear Sentences and Paragraphs
Provide specific detail – answer the reporters questions Use easily understandable words Limit sentence, word, and paragraph length Build coherent paragraphs.
of effective communication
Academic Writing Writing an Abstract.
1 Technical Writing Style Write for Clarity Write for Conciseness.
1 Technical Writing Style Write for Clarity Write for Conciseness.
Improving Readability with Style and Design
Chapter 12 – Strategies for Effective Written Reports
Technical Writing for Researchers and Graduate Students Spring 2003 Lincoln Campus Instructor: Deborah Derrick.
The Writing Center Presents: Editing Developed by Joy N. Patterson.
Computer Engineering 294 R. Smith Writing Skills 03/ Breaking Old Habits Generally we follow old habits. There are hundreds of rules to learn. –
Definition Goals Writing Process
Your Reactions to the Editing Assignment? What was hard? What was easy? Was it a useful exercise? – Is there a way for me to tailor the assignment to make.
1 Business Writing in a Technical Environment Prepared by Graham Associates copyright 2002 copyright © 2002.
Source: How to Write a Report Source:
Chapter Nineteen Preparing Oral Reports--the Basics.
Succeeding in the World of Work Effective Writing.
MECHANICS OF WRITING C.RAGHAVA RAO.
Organisation 1 Chronologically or Reverse-Chronologically 2 In spatial relation 3 From General to Specific (inductive) 4 From Specific to General (deductive)
Writing Process Phase 3 Chapter 7 Kareem Babeel Shihab El Dessouki Saïd Isse Karim Sehaqui Vasken Vosguian.
Report Writing.
Definition Goals Writing Process
Advanced Technical Writing
What Makes an Essay an Essay. Essay is defined as a short piece of composition written from a writer’s point of view that is most commonly linked to an.
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.
Centre for Geo-information Writing a scientific paper RS&GIS Integration Course (GRS ) Lammert Kooistra & Joep Crompvoets Contact:
Pearson Education, Inc. Technical Communication: Process and Product Seventh Edition Sharon Gerson and Steven Gerson.
Writing a Business Letter
A COMMON FORMAT IN WRITING COMPRISES OF: Abstract Introduction Literature Review Material & Methodology Results Discussion Conclusion Acknowledgement References.
Issues Relating To Style and Tone Definition of Style Definition of Tone Gunning Fog Index.
Business Communication Workshop Course Coordinator:Ayyaz Qadeer Lecture # 9.
How to Write An Abstract For Your PACE 8 Project.
Objectives in Technical Writing. ► Clarity ► Conciseness ► Accuracy ► Organization ► Ethics.
English for Academic Purposes Tutor : Paulina Sobinska Course administration – Jennifer Richards
4 C’s of Writing The primary goal of all communication is receiver – reader understanding. To achieve this goal, writers apply the 4 C’s of writing:
Chapter Six Improving Readability with Style and Design McGraw-Hill/Irwin Copyright © 2014 by The McGraw-Hill Companies, Inc. All rights reserved.
Prof Rickus’ Rules of Writing “The Elements of Style” 4th Edition Strunk and White An Excellent Writing Reference:
Improving Readability with Style and Design
Writing Workshop Priscilla L. Griffith, Ph.D. University of Oklahoma Slide 1.
Evaluating 6 th Grade Literature By: Lorraine M. Carmona Torres Prof. E. Lugo ENGG 633 December 2 nd, 2010.
8 Writing Style “A collection of good sentences resembles a string of pearls.” ― Chinese proverb.
News Writing News writing is also called journalistic writing.
DESIGNING AN ARTICLE Effective Writing 3. Objectives Raising awareness of the format, requirements and features of scientific articles Sharing information.
© 2003 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 13 Revising for Readable Style Technical Communication, 9/e John M. Lannon.
11 Chapter 7 Writing Tips For Economics Research Paper 2013, Plamen Nikolov, Harvard University.
BUSINESS COMMUNICATION REVISING BUSINESS MESSAGES REVISING BUSINESS MESSAGES By Mustafa Mustafa MBA EXE HIMS.
How to Develop a Manuscript: More Aspects Barbara Gastel, MD, MPH Professor, Texas A&M University Knowledge Community Editor, AuthorAID.
SAT Critical Reading The critical reading sections on SAT are designed to test your ability to read and understand written English of the level you need.
GRAMMAR AND PUNCTUATION REVISE AND REVIEW WORD CLASSES.
7 C's of effective communication
EXERCISE 1. NO.1 (Worse) All inputs are combined by engineers to create a product. (Better) Engineers combine all inputs to create a product.
Second Grade “I Can” Standards Graphics by Coffee, Kids and Compulsive lists at
Just the plain facts! PRESENTATION SERIES How to write an introduction © Nicholas G. Ashby 2004.
Writing Scientific Research Paper
Self- Assessment Literacy Learning Continuum Example
Definition Goals Writing Process
Writing Tips from a Science Geek
Advanced Technical Writing
Definition Goals Writing Process
Dr. A .K. Bhattacharyya Professor EEI(NE Region), AAU, Jorhat
Chapter 5 Revising Your Writing
How to Write & Revise An Abstract
Definitions and Descriptions
Readability Index Gunning Fog Index The Fog Index is a method of
EXPLORE TEST 9th Grade Students Friday, April 18th 2008.
Writing Tips from a Science Geek
Communication Skills for Engineers
Communication Skills for Engineers
Presentation transcript:

Objectives in Technical Writing Lecture 3&4 Objectives in Technical Writing

Objectives Clarity Conciseness Accuracy Organization Ethics

CLARITY Provide specific detail Answer the reporter’s questions Use easily understandable words Use verbs in the active voice

CLARITY 1) Provide Specific detail Supply specific quantified information, avoid vague or abstract adverbs and adjectives e.g some or recently. State exact meaning

CLARITY 2)Answer the Reporter’s questions Who, what, when, where, why and how 3) Use Easily Understadable Words i)Avoid Obscure Words: Write to express not to impress

Using Acronyms, Abbreviations, and jargon Acronym: single word created from the first letters of multiple words -Scuba(self contained underwater breathing apparatus) -radar(radio detecting and ranging) -NASA(National Aeronautics Space Agency)

Abbreviations: -FBI(Federal Bureau of Investigations) -IBM(International Buiness Machines) -L.A(Los Angeles) -U.E.T Jargon: heaters(for fast balls in Baseball)

Guess the meaning of the following abbreviations and jargons: CIA???? Spaghetti??? FIFO???

Solution: -Parenthetial Definitions i.e CIA(Cash in advance) -Glossary

Active Voice versus Passive Voice

CONCISENESS Provide thorough details in fewer words -conciseness saves some time -it aids in comprehension

How to achieve Conciseness 1)Limit Paragraph Length 2)Limit word and Sentence Length 3)Avoid Camouflaged Words 4)Avoid the Expletive Pattern it allows you some time to understand the contents separately it gives you a room to breathe

1)Limit Paragraph Length “Please Prepare to supply a readout of your findings and recommendations to the officer of the Southwest Group at the completion of your study period. As w discussed, the undertaking of this project implies no currently known incidences of impropriety in the Southwest Group, nor is it designed specifically to find any. Rather, it is to assure ourselves of sufficient caution, control, and impartiality when dealing with an area laden with such potential vulnerability. I am confident that we will be better served as a company as a result of this effort”.

Limit Paragraph Length No more than 4 to 6 typed lines No more than 50 words Short paragraphs are manageable Cut long paragraph at logical places

Improved version Please Prepare to supply a readout of your findings and recommendations to the officer of the Southwest Group at the completion of your study period. As w discussed, the undertaking of this project implies no currently known incidences of impropriety in the Southwest Group, nor is it designed specifically to find any. Rather, it is to assure ourselves of sufficient caution, control, and impartiality when dealing with an area laden with such potential vulnerability. I am confident that we will be better served as a company as a result of this effort.

2)Limit word and Sentence Length Excessively long words and sentences add haze to the writing. Fog index should not be greater than 13 Robert Gunning’s Method for Fog Index Take a full passage that is around 100 words (do not omit any sentences). Find the average sentence length (divide the number of words by the number of sentences). Count words with three or more syllables (complex words), not including proper nouns (for example, Djibouti), familiar jargon or compound words, or common suffixes such as -es, -ed, or -ing as a syllable. Add the average sentence length and the percentage of complex words Multiply the result by 0.4 Example:

Fog Index and Reading Level By Grade 17 College Graduate 16 College Senior 15 College Junior 14 College 13 12 High School Senior 11 High School Junior 10 High School sophomore 9 High School Freshman 8 Eighth Grade 7 Seventh grade 6 Sixth grade

Interpretation of Fog Index 22% americans graduate Writing at college level means that you are ignoring 78% of the readers

Calculating Fog Index Passage from the Wikipedia article on "logorrhoea" The word logorrhoea is often used pejoratively to describe prose that is highly abstract and contains little concrete language. Since abstract writing is hard to visualize, it often seems as though it makes no sense and all the words are excessive. Writers in academic fields that concern themselves mostly with the abstract, such as philosophy and especially postmodernism, often fail to include extensive concrete examples of their ideas, and so a superficial examination of their work might lead one to believe that it is all nonsense.

Example Passage from the Wikipedia article on "logorrhoea" The following paragraph has a Gunning Fog Index of 16.6. The word logorrhoea is often used pejoratively to describe prose that is highly abstract and contains little concrete language. Since abstract writing is hard to visualize, it often seems as though it makes no sense and all the words are excessive. Writers in academic fields that concern themselves mostly with the abstract, such as philosophy and especially postmodernism, often fail to include extensive concrete examples of their ideas, and so a superficial examination of their work might lead one to believe that it is all nonsense.

Analysis There are 86 words in three sentences. The 11 italic words are considered complex. 0.4 ((86 / 3) + 100 (11/86)) 0.4 x ( 28.67 + 12.79) Fog index = 16.6

Assignment Question1 As a result of the military, economic, scientific, political, and cultural influence of the United Kingdom from the 18th century, and of the United States since the mid 20th century, it has become the lingua franca in many parts of the world, and the most prominent language in international business and science. It is used extensively as a second language and as an official language in the European Union and many Commonwealth countries, as well as many international organisations.

Assignment Question2 Passage from the Wikipedia article on "The English Language" As a result of the military, economic, scientific, political, and cultural influence of the United Kingdom from the 18th century, and of the United States since the mid 20th century, it has become the lingua franca in many parts of the world, and the most prominent language in international business and science. It is used extensively as a second language and as an official language in the European Union and many Commonwealth countries, as well as many international organisations.

Ways to Lower High Fog Index Use the Meat Cleaver Method of Revision Avoid Shun Words Avoid Camouflaged Words Avoid the Expletive Pattern Omit Redundancies Avoid Wordy Phrases

Meat Cleaver Method Cut the sentence in half or thirds Example: To maintain proper stock balances of respirators and canister elements and to ensure the identification of physical limitations which may negate an individual’s previous fit-test, a GBC-16 Respirator Request and Issue Record will need to be submitted for each respirator requested for use.

Meat Cleaver Method….contd Version2: Please submit a GBC-16 Respirator Request and Issue Record for each requested respirator. We then can maintain proper respirator and canister elements stock balances. We also can identify physical limitations which may negate an individual’s previous fit-test.

Avoid Shun Words Example: 1) “to ensure the identification of physical limitations” Identify physical limitations 2) “I want you to take into consideration the following” Consider the following . Comprison: 66% reduced

Some Examples Shun word Concise Version Came to the conclusion Concluded or decided With the exception of Except for Make revisions Revise Utilization of Use Consider implementation implement

Avoid Camouflaged words The keyword is burried in the middle of surrounding words(usually helper words or unneeded words) e.g with the exception of----------except

Some camouflaged words For the purpose of discussing discuss Arrive at an agreement agree At a later moment later Make an amendment to amend Have a meeting meet

Avoid Expletive Pattern Avoid “there is” , “it is” pattern Example: “There are three people who will work for Acme” ……….9 words Revised Version: Three people will work for Acme…………………...6 words Omitted 3 words or 33% Example 2: It has been decided that ten engineers will be hired. Revised: Ten Engineers will be hired

Omit Redundancies During the year of 2000 In the month of December Needless to say We collaborated together on the project This is a new innovation

Avoid Wordy Phrases Due to the fact that …………because Enclosed please find…………enclosed is In the near future……………..soon

Accuracy 1)Let someone else read it 2)Use the gestation approach 3)Read backwards 4)Read one line at a time 5)Read long words syllable by syllable 6)Use Technology 7)Check figures, scientific and technical equations, and abbreviations 8)Read it out Loud 9)Try scattershot proofing 10)Use a dictionary