report technical writing

22
Report Technical Writing 1

Upload: jersey

Post on 10-Feb-2016

74 views

Category:

Documents


0 download

DESCRIPTION

Report Technical Writing. Report Style. The report must be clear, concise and complete. Ideas must be expressed in a logical flow and a complete sentences. The report indicates honestly what happened and why. The report should be written in third person as well as in past tense. - PowerPoint PPT Presentation

TRANSCRIPT

Page 1: Report Technical Writing

Report Technical Writing1

Page 2: Report Technical Writing

Report Style

The report must be clear, concise and complete.

Ideas must be expressed in a logical flow and a complete sentences.

The report indicates honestly what happened and why.

The report should be written in third person as well as in past tense.

2

Page 3: Report Technical Writing

Report Style cont.3

The report should be written on 8-1/2 inch by 11 inch white paper with a minimum of one inch margin at the top and sides.(Letter size)

The page numbering should be centered or right aligned in the bottom margin (footer).

The report should not be written in a font smaller than (10 Times New Roman).

Page 4: Report Technical Writing

Report Style cont.4

Section headings should be bold type with no smaller than (10 Times New Roman).

The report should be stapled together in the upper left hand corner of the report.

Page 5: Report Technical Writing

Report Format5

Title PageTable of contents, list of figures and list of tables. AbstractIntroductionObjective Equipments

Page 6: Report Technical Writing

Report Format con.6

ProceduresResults and discussionConclusion and recommendationsReferencesAppendices

Page 7: Report Technical Writing

Title Page7

It consists of:

1.University, faculty, dep. and course.2.Report title and experiment number.3. Names of authors of the report.4. Instructor name.4.The date of the report submission.

Page 8: Report Technical Writing

Table of Contents8

The sections of the same level are aligned with each other.

Page numbers are right-aligned with each other so that the last digit in a number is always in the same column.

Main chapters or sections are all caps.

Lower levels use sentence style caps.

Page 9: Report Technical Writing

Abstract9

The report contains one paragraph abstract .(no more 250 words).

It describes the entire report including the significant results with specific numbers.

Page 10: Report Technical Writing

Introduction10

The report introduction should be one or two paragraphs.

It describes the background material for the report and the related information.

It should be interesting to read and encourage the reader to complete the report.

Page 11: Report Technical Writing

Objective11

The objective of the Report should be stated in ONE sentence or short paragraph.

Example:<<The objective of this report is to report the

measurements of the sample block taken during Laboratory Exercise One.>>

Page 12: Report Technical Writing

Equipments12

In this section, the equipments of the experiment and the most important characteristics and parameters of each equipment are mentioned.

Page 13: Report Technical Writing

Procedures13

This section describes exactly how the experiment was performed.

It should be written in your own words.

Any assumption or limitation should be mentioned.

Long, detailed procedures should be placed in the Appendix.

Page 14: Report Technical Writing

Results and Discussion14

Raw data taken during the experiment should be presented in an appropriate from such as tables, graphs, figures, or photographs.

Whenever graphics are used, special attention should be given to the drawing scale in order to yield meaningful curves that clearly indicate the significance of the results.

Discuss data with regard to trends, compare results between different methods, etc.;.

Page 15: Report Technical Writing

Results and Discussion15

Discuss the significance of the results as related to the objectives.

Identify possible sources of experimental error and if these have affected the results.

It may include a correlation and/or a comparison of your experimental results with those that can be predicted from theories or the use of theoretical analysis, and try to explain any discrepancies.

Page 16: Report Technical Writing

Conclusion and Recommendations16

Conclusions are the important finding determined from the experiment.

All statements must be supported by the data and the results.

New information not reported on earlier can not be introduced in this section.

Page 17: Report Technical Writing

Conclusion and Recommendations17

Any judgments made should pertain directly to the work.

Present the important recommendations that you have drawn from your results

Page 18: Report Technical Writing

References 18

Author name (Publishing Date), "reference book title", edition, publisher and publishing place.

e.g: Sherif D. El Wakil; Material Science and Engineering Lab Manual; PWS Publishing Company, Boston; 1994.

For web sites: Company or foundation name The link

Page 19: Report Technical Writing

Figures 19

The title is placed under the figure. Each axis should be placed in a normal position along

the bottom and the left of the figure.

The axis needs to be labeled with its variable, symbol and appropriate units.

Figures should be mentioned in the text.

Page 20: Report Technical Writing

Tables20

The table title is placed above the table. Tables should be inserted in the text immediately after

their reference.

Each column will be labeled with a short heading, including the units.

Where tables run over several pages, the table will have headings on each page.

Page 21: Report Technical Writing

Numbering 21

All pages in the report are numbered; but on some pages, the numbers are not displayed ( Title Page)

All pages before the introduction uses lowercase Roman numerals.

All pages beginning with and following the introduction use Arabic numerals.

Page 22: Report Technical Writing

Grade Policy22

The report must be typed i.e.; handwritten reports will NOT be accepted.

You should submit the report ONE week after the experiment is conducted.

Any lateness after the deadline will affect your grade.

The report of non-attended experiment will grade to ZERO.

Any similar report will grade to ZERO.