Introduction to technical writingPresentation Transcript
(Technically) IT’S 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)
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
Can the sample written work be changed into technical writing format?
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.
Distinguish technical from creative writing
Creative vs. Technical Goal To communicate facts, explain procedures, critically evaluate evidence. To evoke images and emotion
Today’s a day for hearts and cards, For chocolates, flowers, too, But most of all, today’s a day To celebrate me and you. Don’t get me wrong, for every day With you is a celebration Of 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.
Creative vs. Technical words Many descriptive words used to create setting/ image Conciseness encouraged and valued
Creative vs. Technical Emphasis Character and character development Facts, accuracy, precision
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.
Technical writing is the presentation and communication of accurate and objective, scientific and technologic information, ideas, or procedures.
is using scientific and technical vocabulary
is highly specific and detailed
uses tables, graphs, and figures to clarify and support textual discussion
uses conventional report forms
can be analyzed logically and evaluated scientifically
leaves no room for conflicting interpretations
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.
Analyze events and their implications
Persuade and influence decisions
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
Examples of Technical Materials
Various kinds of written reports
Articles for technical journals or books
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
He must use specific, single, concrete words, and familiar language that cannot be misinterpreted.
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.”
“ 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.”
long word shorter word etiology cause administer give comprise are dosages doses employ use (verb) utilize use (verb) usage use (noun) efficacious effective encountered seen methodology method pathology disease virtually almost 2. Use short words instead of long words
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 patients
looked at examined
turned to tried
more and more increasingly
suffer from experience or have
sufferers patients or people or individuals
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…”
“ Severe hypoglycemia is scary and leaves the patient feeling totally wiped out for awhile.”
“ Severe hypoglycemia can be a frightening experience for patients, and often leaves them feeling fatigued
4. Avoid metaphors .
Metaphors are names or descriptive terms applied to an action or
object that is imaginative but not literally applicable
“the pot filibustered on the stove”
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.”
He must make his report very presentable in format. The layout must conform with standard forms of writing.
ACTIVITIES IN THE WRITING PROCESS More proofreading More peer evaluating Starting a rough draft Studying lecture notes Determining the purpose Locating sources Proofreading Writing another draft Clustering related ideas Reading related materials Talking to professors Spell checking Peer reading and evaluating Listing ideas Searching the internet Talking to peers Editing Revising Drafting Gathering information Planning