Technical report writing
Download as PPT, PDF9 likes11,545 views
This technical report outlines key aspects of technical report writing such as definition, objectives, structure, and best practices. It defines a technical report as a document describing the process, progress, or results of technical research. The report should have a clear purpose, aims, and be organized with sections for an introduction, body, conclusions, as well as features like a summary, table of contents, and list of graphics. Finally, it provides tips for good report writing such as keeping it concise, organized for the reader, and ensuring accuracy and quality in writing and presentation.
Technical report writing
- 1. TECHNICAL REPORT WRITING QURATULAIN MUGHAL BATCH IV ISRA UNIVERSITY
- 2. CONTENTS 1.Definition 2.Objective 3.Introduction 4.The good technical report 5.Example of the technical report writing 6.Summary Or Executive Summary 7. Table of Contents 8. List Of Graphics 9. Conclusions 10.Key points for good technical report writing
- 3. 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”
- 4. OBJECTIVE • It identify exactly what information it covers? • For whom it is written? • And why it should be produced?
- 5. 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
- 6. 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.
- 7. 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
- 8. 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.
- 9. TABLE OF CONTENTS • include all chapter headings and sub- headings • use indentation and spacing for effective layout • identify each appendix.
- 10. LIST OF GRAPHICS • List of Tables with titles and page numbers • List of Figures with titles and page numbers.
- 11. CONCLUSIONS • conclusions based on objectives of work or summary of work performed • limitations of project work
- 12. 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.