lec 1-technical writing

1

HAIRUZILA IDRUS

Office – West Wing, Level 3 Building 21

Phone (O) – 05-3687734

Email – hairuzi@petronas.com.my

Consultation hours: By appointment

2

BASIC CONCEPTS IN TECHNICAL WRITING

3

What is ‘technical writing’?

A generic term for all written communications done on the job.

It places greater emphasis on techniques of organization and format that help readers find important information as quickly as possible.

4

ACADEMIC WRITING vs. TECHNICAL WRITING

Features of Academic Writing:

1. Purpose: demonstrating what you know about the topic, in a way that justifies a high grade.

2. Your knowledge of topic: less than the teacher who evaluates the writing.

3. Audience: teacher who requests the assignment and who will read it from beginning to the end.

4. Criteria for evaluation: depth, logic, clarity, unity and grammar.

5. Statistical and graphic support: Sometimes used to explain and persuade

5

ACADEMIC WRITING vs. TECHNICAL WRITING

Features of Technical Writing:

1. Purpose: getting something done within an organization.

2. Your knowledge of topic: usually greater than that of the reader.

3. Audience: often several people, with differing technical background.

4. Criteria for evaluation: clear and simple organization of ideas, in a format that meets the needs of busy readers.

5. Statistical and graphic support: Frequently used to explain existing conditions and to present alternative courses of action.

6

ACADEMIC WRITING vs. TECHNICAL WRITING

Differences between Academic Writing and Technical Writing.

1. Technical writing has a practical role on the job, whereas academic writing aims only to display your knowledge.

2. Technical writing is done by an informed writer conveying needed information to an uninformed reader, whereas academic writing is done by a student as learner for a teacher as source of knowledge.

3. Technical writing often is read by many readers, whereas academic writing aims to satisfy only one person, the teacher.

7

Written communication process

Planning Drafting Revising

Determine purpose Edit for mechanics

Analyze readers Edit for grammar

Collect information Edit for style

Write initial

drafts

Complete outline Adjust content

8

Determining purpose of document:

Why am I writing this document?What response do I want from the readers?

Answers should pinpoint exactly what you want to happen as a result of your

document.

Time out! Lets take a break…

10

BASIC CONCEPTS IN TECHNICAL WRITING

1. TECHNICAL WRITING IS AUDIENCE-CENTERED

Deals with specific situation

Enables readers to act

Occurs within a community

Is interactive

Has definite purpose

11

BASIC CONCEPTS IN TECHNICAL WRITING

2. TECHNICAL WRITING IS PRESENTATIONAL

Use the top-down method

Use headings

Use chunks

Use visual aids

Establish a consistent visual logic

Use plain and objective language

12

BASIC CONCEPTS IN TECHNICAL WRITING

Objective language:

Example:

a. A hazard exists if contact is made with this part

while it is whirling.

b. Warning. Turn off all power before you remove

the cover. The blade underneath could slice off

your fingers! – objective language

13

BASIC CONCEPTS IN TECHNICAL WRITING

3. TECHNICAL WRITING IS RESPONSIBLE

Use honest language

Use format honestly

Create helpful visuals

Use direct, simple expression

Credit others

Codes of ethical conduct

14

WRITE FOR YOUR READER,NOT FOR YOURSELF.

THE END