Chapter 03 2014 15 tr

Preview:

Citation preview

Technical Report Writing

Prof. Dr. Magdi El-Saadawi

For First Grade EE Students

Prof. Dr. Magdi El-Saadawi

www.saadawi1.netsaadawi1@gmail.com

2014-2015

Criteria معاییر for

Good Technical Writing

Chapter 3

Good Technical Writing3.1. Elements of writing strategy

3.2. Aspects of technical reports

3.2.1 Technical Contents

3.2.2 Presentation

3.2.3 Language Skills

3.1. Elements of writing strategy pp. 28

Readership (the who) of a document (audience)

Scope (the what) of a document

Purpose and objectives (the why) of a document

3.2. Aspects of technical reports pp. 30

Technical Content

Presentation technique (writing style)

Use of the language

3.2.1 Technical Contents

Word Usage Appropriate for Readership.

Useful Information for Selected Readers

No Plagiarism

Factual Information/Supporting Data. Factual Information/Supporting Data.

Clear Purpose

Sources of Information Credited

Understandable Statistics.

3.2.2 Presentation

Logical Sections.

No Bias

Interesting

Specific Specific

Report Mechanics

Hierarchical Headings التسلسل الھرمي

3.2.3 Language Skills

No excessive use of Jargon or Acronyms

No Misspelling

No Punctuation Errors

Mixed Sentence Length

Written in the Active Voice

Reasonable Grammar

Concision اإلیجاز

Recommended