technical report writing

14
TECHNICAL REPORT WRITING QURATULAIN MUGHAL BATCH IV ISRA UNIVERSITY

Upload: quratulain-mughal

Post on 07-Aug-2015

38 views

Category:

Engineering


5 download

TRANSCRIPT

Page 1: Technical report writing

TECHNICAL REPORT WRITING

QURATULAIN MUGHALBATCH IV

ISRA UNIVERSITY

Page 2: Technical report writing

CONTENTS

1.Definition2.Objective3.Introduction4.The good technical report5.Example of the technical report writing6.Summary Or Executive Summary7. Table of Contents 8. List Of Graphics 9. Conclusions10.Key points for good technical report writing

Page 3: Technical report writing

TECHNICAL OR SCIENTIFIC REPORT WRITING

DEFINITION:

“It is a document that describes the process, progress, or results of technical or scientific research or the state of a technical or scientific research problem”

Page 4: Technical report writing

OBJECTIVE

• It identify exactly what information it covers?

• For whom it is written?

• And why it should be produced?

Page 5: Technical report writing

INTRODUCTION

• It includes:

1. Background to the topic

2. A clear statement of the purpose of the report

3. A clear statement of the aims of the project

Page 6: Technical report writing

THE GOOD TECHNICAL REPORT

• A good report is easy to recognize.• Its title is precise and informative, its layout and

format are well organized.• Reading a well written report is pleasurable : the

style is accurate, fluent and concise.• The diagrams, which includes to guide non-

verbal material such as tables and graphs, are well presented and clearly labeled.

Page 7: Technical report writing

EXAMPLE

• Annual or executive report:• It is made on yearly basis to show the

performance of a company at the end of the period.

• It contain:

1.Company profile

2.Financial highlights

4.Board of directors and officers

5.Auditors report

Page 8: Technical report writing

SUMMARY OR EXECUTIVE SUMMARY

• a summary of the purpose and findings of the work

• usually limited to one page

• a stand alone document "summarizing" the work.

Page 9: Technical report writing

TABLE OF CONTENTS

• include all chapter headings and sub-headings

• use indentation and spacing for effective layout

• identify each appendix.

Page 10: Technical report writing

LIST OF GRAPHICS

• List of Tables with titles and page numbers

• List of Figures with titles and page numbers.

Page 11: Technical report writing

CONCLUSIONS

• conclusions based on objectives of work or summary of work performed

• limitations of project work

Page 12: Technical report writing

KEY POINTS FOR GOOD TECHNICAL REPORT WRITING

• The reader is the most important person.• Keep the report as short as possible.• Organize for the convenience of the report user.• All references should be correct in all details.• The writing should be accurate, concise and unobtrusive.• The right diagram with the right tables should be in the

right place for the reader.• Summaries give the whole picture, in miniature.• Report should be checked for technical errors, typing

Errors and inconsistency.• The report should look as good as it is.

Page 13: Technical report writing
Page 14: Technical report writing