36
(Technically) IT’S TECHNICAL WRITING

Introduction to technical writing

Embed Size (px)

DESCRIPTION

:)

Citation preview

Page 1: Introduction to technical writing

(Technically) IT’S TECHNICAL WRITING

Page 2: Introduction to technical writing

Let’s say, you are given 1 minute to scribble your thoughts, whatever it is, how many different ideas would that be…it wouldn’t matter. JUST WRITE (without a pause)

Page 3: Introduction to technical writing

READY

begin

Page 4: Introduction to technical writing

Free writing

Start: The best of both worlds is nowhere. Could you ever imagine something terrible and best all at the same time. I’m talking about the guest speaker in the recent seminar I attended. Was it a seminar? Hmmmm I mean lecture. (sigh) Whatevah! Going back... The thing is, nothing can ever tell me

Page 5: Introduction to technical writing

Can the sample written work be changed into technical writing format?

Answer is?_______________

Page 6: Introduction to technical writing

Yes, we can!We have to single out terms used in the

paragraph. • Lecture and seminar

Sample of technical writing:A lecture is an oral presentation intended to present information or teach people about a particular subject, for example by a university or college teacher. On the other hand, a seminar is, generally, a form of academic instruction, either at a university or offered by a commercial or professional organization. It has the function of bringing together small groups for recurring meetings, focusing each time on some particular subject, in which everyone present is requested to actively participate.

Page 7: Introduction to technical writing

Distinguish technical from creative writing

Page 8: Introduction to technical writing
Page 9: Introduction to technical writing

Creative vs. Technical

Goal

To communicate facts, explain procedures, critically evaluate evidence.

To evoke images and emotion

Page 10: Introduction to technical writing

Today’s a day for hearts and cards,For chocolates, flowers, too, But most of all, today’s a dayTo celebrate me and you.

Don’t get me wrong, for every dayWith you is a celebrationOf our love, our hopes and dreams,Our solid, strong foundation.

This research may provide an alternative solution to the problem of monotonous and labor-intensive meter reading of electric company personnel; and tedious payment of bill, to the part of consumers. It may also be recommended to commercial and leasing establishments where tenants are held accountable for their own electric bill.

Page 11: Introduction to technical writing
Page 12: Introduction to technical writing

Creative vs. Technical

words

Many descriptive words used to create setting/ image

Conciseness encouraged and valued

Page 13: Introduction to technical writing
Page 14: Introduction to technical writing

Creative vs. Technical

Emphasis

Character and character development

Facts, accuracy, precision

Page 15: Introduction to technical writing

What is technical writing?

It is a technical communication (in any field) that primarily aims to convey a particular piece of information for a particular purpose to a particular reader or group of readers.

Page 16: Introduction to technical writing

Define:

Technical writing is the presentation and communication of accurate and objective, scientific and technologic information, ideas, or procedures.

Page 17: Introduction to technical writing

Technical writing…

is exposition is using scientific and technical vocabulary

Accounting terms.pptComputer Terms.ppt Legal terms.pptFinancial terms.ppt

is highly specific and detailed uses tables, graphs, and figures to clarify and

support textual discussion

Page 18: Introduction to technical writing

Cont…

uses conventional report forms can be analyzed logically and

evaluated scientifically leaves no room for conflicting

interpretations

Page 19: Introduction to technical writing

What is the purpose of technical writing?

Give information that leads to the accomplishment of scientific tasks and in the making of the needed decisions.

Page 20: Introduction to technical writing

(Purpose)

Analyze events and their implications

Page 21: Introduction to technical writing

(Purpose)

Persuade and influence decisions

Page 22: Introduction to technical writing

What about its subject matter?

Objective information that is accurately and clearly presented

Data in business, science, engineering, industry, and in all formal aspects of professional areas

Factual data statistics

Page 23: Introduction to technical writing

Examples of Technical Materials Various kinds of written reports Oral reports Business letters Articles for technical journals or books Abstracts Graphic aids Handbooks Brochures Specifications Memoranda Proposals

Page 24: Introduction to technical writing

What are the Basic Principles of Good Technical Writing?

The writer of a report must have a specific reader or group of readers in mind.

He must decide what the specific purpose of his report is and make sure that every part of his report contributes to that purpose

Page 25: Introduction to technical writing

(Basic Principles…)

He must use specific, single, concrete words, and familiar language that cannot be misinterpreted.

Page 26: Introduction to technical writing

General rules for word choice or Ten Tips for Technical Writers

1. Break long sentences up into shorter sentences.

• “A complete pharmacokinetic study prevented the investigators from missing any important perturbations, which could have been due to any of the following: poor absorption of oral doses or lack of conversion of prednisone to prednisolone.”

Page 27: Introduction to technical writing

“A complete pharmacokinetic study allowed the investigators to rule out confounding factors. They tested the rate and extent of prednisone absorption. They also examined prednisone to prednisolone conversion. Differences in absorption or conversion could otherwise have accounted for the differences in clearance between the groups.”

(shorter sentences)

Page 28: Introduction to technical writing

long word shorter wordetiology causeadminister givecomprise aredosages dosesemploy use (verb)utilize use (verb)usage use (noun)efficacious effectiveencountered seenmethodology methodpathology diseasevirtually almost

2. Use short words instead of long words

Page 29: Introduction to technical writing

3. Avoid colloquialism. Avoid emotion-evoking word.

Avoid: Instead, use:“on,” as in “of” or “in,” as in“study on 100 patients” study of 100 patientslooked at examinedturned to triedmore and more increasinglylevels concentrationssuffer from experience or havesufferers patients or people or

individuals

Page 30: Introduction to technical writing

Colloquial/emotion-evoking “Even though the authors claim no conflict of interest, this study seems to be reeking of manipulated data.”

Professional“The authors claimed that their prior association with the manufacturer did not lead to conflict of interest. Several inconsistencies in data interpretation challenge this assertion. The first inconsistency was…”

Page 31: Introduction to technical writing

Colloquial/emotion-evoking “Severe hypoglycemia is scary and leaves the patient feeling totally wiped out for awhile.”

Professional“Severe hypoglycemia can be a frightening experience for patients, and often leaves them feeling fatiguedafterward.”

Page 32: Introduction to technical writing

4. Avoid metaphors.

Metaphors are names or descriptive terms applied to an action orobject that is imaginative but not literally applicable

for example“the pot filibustered on the stove”

Page 33: Introduction to technical writing
Page 34: Introduction to technical writing

(Basic Principles…)

The writer must check every part of his report to see whether he has followed the principles of first, “Telling the reader what he is going to tell them; second, telling them; and third, telling them what he told them.”

Page 35: Introduction to technical writing

(Basic Principles…)

He must make his report very presentable in format. The layout must conform with standard forms of writing.

Page 36: Introduction to technical writing

Planning Gathering information

Drafting Revising Editing

Talking to peers

Searching the internet

Listing ideas

Peer reading and evaluating

Spell checking

Talking to professors

Reading related materials

Clustering related ideas

Writing another draft

Proofreading

Determining the purpose

Studying lecture notes

Starting a rough draft

More peer evaluating

More proofreading

Locating sources

ACTIVITIES IN THE WRITING PROCESS