presentation of chapter 01 technical writing

14
Technical Report Writing Prof. Dr. Magdi El-Saadawi www.saadawi1.net [email protected] 2014-2015 For First Grade EE Students

Upload: magdi-saadawi

Post on 01-Dec-2014

529 views

Category:

Education


0 download

DESCRIPTION

Presentation of Chapter 01 Technical Writing

TRANSCRIPT

Page 1: Presentation of Chapter 01  Technical Writing

Technical Report Writing

Prof. Dr. Magdi El-Saadawi

[email protected]

2014-2015

For First Grade EE Students

Page 2: Presentation of Chapter 01  Technical Writing

Course OutlinesChapter 1

Technical Writing: An Overview

Chapter 2

Ethical Considerations

Chapter 3

Criteria for Good Technical Writing

Chapter 4

Methodology for Writing a Report

Chapter 5

FORMAL REPORTS

Page 3: Presentation of Chapter 01  Technical Writing

Course OutlinesChapter 6

Applications in Report WritingLaboratory Reports Periodic Reports

Design Reports Proposals

Field Reports

Chapter 7

Scientific ReportsTheses and Dissertations Scientific Researches

Chapter 8

Writing a Successful CV

Chapter 9

Making Presentation

Page 4: Presentation of Chapter 01  Technical Writing

Technical Writing:

An Overview

Chapter 1

1.1. What is Technical Writing?

1.2. Attributes of Technical Writing

Page 5: Presentation of Chapter 01  Technical Writing

1.1. What is Technical Writing?

Technical Writing is a type of writing where the author is writing about a particular subject that requires direction, instruction, or explanation.

The goal of technical writing is to enable readers to use a technology or understand a process or concept

Page 6: Presentation of Chapter 01  Technical Writing

1.1. What is Technical Writing?

• The major types of documents in technical writing can be grouped into four major categories :

Reports and communications in day-to-day business in technical fields

Technical papers for research, teaching and education

Operational manuals, instructions, or procedures

Patents براءات اختراع

Page 7: Presentation of Chapter 01  Technical Writing
Page 8: Presentation of Chapter 01  Technical Writing

1. day-to-day technical reports

• reports are a major part of the development and applications of technology.

• if an engineer spends a year developing a new

transmission ناقل حركة for a car, several types of

reports are needed for the design, evaluation,

and implementation of the new component.

Engineering must also report to management on

the viability of design, costs, and work objectives.

Page 9: Presentation of Chapter 01  Technical Writing

2. Documents for research teaching and education

Scripts سيناريوهات

magazine articles,

books,

papers أبحاث , and

degree theses رسائل جامعية.

Page 10: Presentation of Chapter 01  Technical Writing

3. Operational manuals, instructions, or procedures

• Technical writing is for, instructions إرشادات,

manuals and procedures إجراءات

They have legal/liability implications مسؤولية/ قانونية آثار

written by professional technical writers.

Page 11: Presentation of Chapter 01  Technical Writing

4. Patents براءات اختراع

Lawyers usually write patents, with lots of

writing and searching on the part of the

applicant.

Page 12: Presentation of Chapter 01  Technical Writing

1.2. Attributes خصائص of Technical Writing

• In general, technical writing has a degree of

formality إجراءات شكلية , and

it generally focuses on a specific subject

with the purpose of making something

happen or sharing useful information or

knowledge.

Page 13: Presentation of Chapter 01  Technical Writing

1.2. Attributes خصائص of Technical Writing

The following attributes define

some key characteristics that distinguish

technical writing from other types of

writing.

Page 14: Presentation of Chapter 01  Technical Writing

1.2. Attributes of Technical Writing

• It pertains ذات عالقة to a technical subject.

• It has a purpose.

• It has an objective.

• It conveys information/facts/data.

• It is impersonal.

• It is concise موجزة

• It is directed موجهة

• with a particular style and in a particular format.

• It is archival.

• It cites contributions of others تستشهد بمساهمات اآلخرين