Technical Writing Style

Slides:



Advertisements
Similar presentations
Academic Writing Writing an Abstract.
Advertisements

Effective Recommendation Reports What to say and how to say it.
Copyright 2012 by Arthur Fricke Effective Grammar and Style these are some tips and tricks to supplement the grammar and style editing info/advice in the.
Chapter 12 – Strategies for Effective Written Reports
AuthorAID Workshop on Proposal Writing Rwanda June 2011.
Digital Key Concepts Management 102 Professor Estenson PREPARING TO WRITE.
Proofreading, Editing & Revising Customized & Workplace Training AAI/Portland Community College Facilitated by George Knox.
Computer Engineering 294 R. Smith Writing Skills 03/ Breaking Old Habits Generally we follow old habits. There are hundreds of rules to learn. –
Technical Communication 1
Writing a Book Review Alexis A. Fruia March 16-20, th Grade English.
UAB UNIVERSITY WRITING CENTER Improving Paragraphs for Academic Writing.
The Technical Writing Process Lecture-2 ( ) Prepared By: Prepared By: Syed Abrar Hussain Shah.
AHSGE Test Vocabulary Language Mrs. Julie Turner School Improvement Specialist Dothan City Schools Dr. Patrick Cain SEHS Assistant Principal Elmore County.
Organizing s Breana, Hunter, Emily. Your goal is to organize your message so that it is clear and concise to your readers.
Revising and Editing Your Research Paper. Self-Revision In the revision step, focus on the following questions and strategies:  Assignment requirements:
Features of technical writing Personal( I, we) vs impersonal (writer, author), one - ambiguity Passive vs active Clarity- redundant words Nominalization.
Writing Reports, Proposals, and Technical Documents By Laurie A. Pinkert.
LOCATING THE STATED MAIN IDEA
Scholarship writing in the Sciences (and Social Sciences)
How to Not Suck at Writing Minutes, Notices, and other Communication Danica Schieber, ISU July 30, 2015.
ORGANIZATION. I. Organizational Guidelines 3 GUIDELINES (1) DIFFERENT SECTIONS = DIFFERENT READERS o Organize for ALL readers o READER ANALYSIS: Readers’
Introduction Chapter 10 :: Drafting and Revising Coherent Documents Pages 218 to 236 By: Meghna Nagarajan, Sarah Curet, Brandon Plunkett, Andrew Hardin,
1 Business Writing in a Technical Environment Prepared by Graham Associates copyright 2002 copyright © 2002.
Writing Tips for Evaluators: 10 Principles for Clearer Communication Presented by: Joy Quill C. J. Quill & Associates, Inc. EERS 2008 Copyright 2008 C.
Chapter 6. Writing for Your Readers © 2013 by Bedford/St. Martin's1 Understand eight typical patterns of organization: chronological spatial general to.
Getting the Language Right ITSW 1410 Presentation Media Software Instructor: Glenda H. Easter.
Writing for Business Collaborative Reports Collaborative Writing 87% of all business writing is done in a group or team. The average business document.
Drafting and Revising Effective Sentences Chapter 11 Presented By Blake O'Hare Chris McClune.
Examining the parts of a subject... From Reading to Writing Manners and proper social behavior are concerns to people in any age—from the Victorians.
Chapter 10. Writing Effective Sentences © 2010 by Bedford/St. Martin's1 Use these seven techniques for structuring effective sentences: Use lists. Emphasize.
New Mexico Supercomputing Challenge Technical Writing Tips and Tricks.
Business Communication Workshop Course Coordinator:Ayyaz Qadeer Lecture # 9.
Beyond single sentences: Cohesion and Coherence. Prose feels like it fits together if 1) The end of one sentence fits with the beginning of the next sentence.
GEB 3213 Lecture 4: Clear Writing Good News Messages Lecture Outline.
Writing Paragraphs that Work. Paragraphing and Meaning A well-written paragraph makes your writing more effective. Each paragraph should focus on a single.
5.1 To accompany Excellence in Business Communication, 5e, Thill and Bovée © 2002 Prentice-Hall Chapter 5 Writing Business Messages.
Some Tips about Writing Technical Papers Michael R. Lyu September 9, 2003.
Chapter 3 The Body Paragraphs. ■ Summary Planning the Body of Your Essay ■ informal outlines Composing the Body Paragraphs The Topic Sentence ■ supports.
Communication for Managers Guidelines for Effective Writing Write strategically Write logically and coherently Use formatting devices and color effectively.
EFFECTIVE WRITING 8 Readability. Writing - time and resource consuming, stressful process Texts have a strong tendency of using more complex, more sophisticated.
Technical Communication A Practical Approach Chapter 17: Style in Technical Writing William Sanborn Pfeiffer Kaye Adkins.
ONLINE WRITING. Can good writing be taught? Being creative – NO! As a craft - YES.
Paragraphs. A group of related sentences set off by a beginning indention or sometimes, extra space Paragraphs give you and your readers a breather from.
Written Presentations of Technical Subject Writing Guide vs. Term paper Writing style: specifics Editing Refereeing.
Principles of Composition
Document Review for Reviewers and Writers. Topics Readability Document Review Structured Reading.
8 Writing Style “A collection of good sentences resembles a string of pearls.” ― Chinese proverb.
Instructor Availability AIM address: EleBranch Office Hours: Mondays & Thursdays 9:00 p.m. to 10:00 p.m. And by appointment.
Abstracting.  An abstract is a concise and accurate representation of the contents of a document, in a style similar to that of the original document.
The Minto Pyramid Principle® Concept  The Minto Pyramid Principle concentrates on the thinking process that should precede writing. It explains how to.
Copyright © 2015 McGraw-Hill Education. All rights reserved. No reproduction or distribution without the prior written consent of McGraw-Hill Education.
Chapter 9. Writing Coherent Documents © 2010 by Bedford/St. Martin's1 Consider these eight questions as you revise the document for coherence: Have you.
Logical Division of Ideas & Coherence
Revise Five Times (then proofread) Article by: Janis Ramey Presentation by: Paul Pietkiewicz.
Julie Mullins-Turner AHSGE Test Vocabulary Language Julie Mullins-Turner.
4 Business Style: Sentences and Paragraphs. Introduction Effective Sentences Effective Paragraphs Proofreading.
(almost) EVERYTHING ABOUT SUMMARIZING Adapted from A Sequence for Academic Writing by L. Behrens, L Rosen and B. Beedles.
TECHNICAL WRITING STYLE
End User Support – User Training
HUM 102 Report Writing Skills
Editing for a Professional Style and Tone
AHSGE Test Vocabulary Language Dr. Patrick Cain
Writing: Rhetoric and Relevance
Marketing Research.
Foundations of Technical Communication Module 2
Wrye’s Top Ten Writing Tips.
Communication Skills for Engineers
Summarizing Use the following slides in order to organize your understanding of the article. After filling in the graphic organizer, then write your summary.
Communication Skills for Engineers
The Technical Writing Process
Presentation transcript:

Technical Writing Style Lecture-5 (28-02-12) By: Syed Abrar Hussain Shah

Today… Guideline for Writing Clear Sentence Guideline for writing Clear Paragraph Guideline for Revising for Clarity Guidelines for Organizing Clearly

Guideline for Writing Clear Sentence Use Normal Word Order Write Sentences of 12 to 25 Words Use Active Voice Use Parallel Structure Put Main Idea First

1- Use Normal Word Order The normal word order in English is subject-verb-object. That order usually produce the clearest, most concise sentences. Clear: Patients write memos to doctors. Wordy: Memos to doctors are kinds of writing done by patients.

Write Sentences of 12 to 25 Words An easy-to-read sentence is 12 to 25 words long. Shorter or longer sentences are weaker because they become too simple or complicated.

Use Active Voice The active voice is more direct than the passive voice. Active Voice: Aslam started his business. Passive Voice: Business was started by Aslam.

Use Parallel Structure Using parallel structure means using similar structure for similar elements. Faulty: Management guarantees that the old system will be replaced and to consider the new proposal. Parallel: Management guarantees that the old system will be replaced and to consider the new proposal will be considered.

Put Main Idea First Place the sentence’s main idea -its subject- first. When you do so you provide the context to what follows.

2- Guideline for writing Clear Paragraph Put the Topic Sentence First Structure Paragraphs Coherently

Put the Topic Sentence First In technical writing, almost all paragraphs begin with a topic sentence, followed by several sentences that explain the central idea. Researchers have discovered that readers comprehend a paragraph more quickly if the general or topic idea is placed first. (Slater) This structure, called deductive, gives your paragraphs the direct, straightforward style preferred by most report readers.

Structure Paragraphs Coherently In a coherent paragraph, each sentence relates clearly to the topic sentence or controlling idea, but there is more to coherence than this. If a paragraph is coherent, each sentence flows smoothly into the next without obvious shifts or jumps.

3- Guideline for Revising for Clarity Avoid String of Choppy Sentences Avoid Wordiness Avoid Redundant Phrases Avoid Abstract and General Terms Use There Are Sparingly Avoid Nominalizations Avoid Noun Clusters Use You Correctly

4- Guidelines for Organizing Clearly Use Context-Setting Introductions Place Important Material First Use Preview Lists Use Repetition and Sequencing Use Structural Parallelism

Use Context-Setting Introductions Your introduction should supply an overall framework so that the reader can grasp the later details that explain and fill it. You can use an introduction to orient readers to the context of the document in one of three ways: To define terms, To tell why you are writing, and To tell the document’s purpose.

Place Important Material First The beginning of a section or paragraph is an emphatic spot. Placing important material first emphasizes its importance. This strategy orients readers quickly and give them a context so that they know what to look for as they read further.

Use Preview Lists Preview lists contain the key words to be in the document. You can use lists in any writing situations to indicate organizations.

Use Repetition and Sequencing Repetition means restarting key subject words or phrases from the preview list. Sequencing means placing the key words in the same order in the text as in the list.

Use Structural Parallelism Structural parallelism means that each section of a document has the same organization.

Thanks a lot…