Writing a Technical report

Slides:



Advertisements
Similar presentations
Report Writing for Business Students. Business School Report Writing Topics 1.Planning 2.Structure & Content 3.Style.
Advertisements

Module 2 Sessions 10 & 11 Report Writing.
Your Project Report is a record of how the problem was solved It provides guidance to your company to implement what you have done It is one of the assessment.
Front and Back Matters Chapter 11.
Reading and writing reports
Chapter 12 – Strategies for Effective Written Reports
Copyright © 2003 by The McGraw-Hill Companies, Inc. All rights reserved. Business and Administrative Communication SIXTH EDITION.
Essays IACT 918 July 2004 Gene Awyzio SITACS University of Wollongong.
Technical Writing II Acknowledgement: –This lecture notes are based on many on-line documents. –I would like to thank these authors who make the documents.
COMM : Applied Organizational Communication Instructor: Dan Lair Day Twenty Three: Reports and Presentations November 15, 2005.
Technical Communication Fundamentals, 1 st Edition W.S. Pfeiffer and K. Adkins © 2011 Pearson Higher Education, Upper Saddle River, NJ All Rights.
1 Technical Report Writing  Purpose of Report Writing  Structure of Report Writing  Layout of Report Writing.
Lecture 3: Writing the Project Documentation Part I
How to Write an Executive Summary
Dr. N. S. Harding Chemical Engineering 477 January 13-14, 2014.
Report Writing Format.
Business Memo purpose of writer needs of reader Memos solve problems
Advanced Research Methodology
ITB/Electronics Master’s Thesis. The aim of a scientific thesis gained insight in methodology for planning and performance of a scientific project qualification.
Engi 1504 – Graphics Lecture 8: Special Topic 1
Source: How to Write a Report Source:
Business Communication Workshop
Science Fair Projects.
Report Writing Sylvia Corsham De Montfort University 2008/9 (in association with Vered Hawksworth BSc.)
Academic Essays & Report Writing
“Committee Progress Report” GRADING ENGL 3365 Copyright 2013 by Arthur Fricke.
GE 121 – Engineering Design Engineering Design GE121 Reporting the Outcome Lecture 7A.
GETTING STARTED FINDING YOUR “VOICE” FOR ACADEMIC WRITING STAYING OUT OF THE “WEEDS” WITH A MAP PULLING IT ALL TOGETHER: VOILA! PRESENTED BY CYNTHIA KING,
How to write a good RESEARCH proposal
Presented by Madhuriya Kumar Dutta Trade and Investment Facilitation Department Mekong Institute, Thailand 16 May 2012.
Basic Outline The basic structure of informative and research writing consists of:  Cover Page  Introduction  Body  Summary  Reference Page.
16-1 Chapter 16 Analyzing Information & Writing Reports   Analyzing Data   Choosing Information   Organizing Reports   Seven Organization Patterns.
What the hell is a “Report” ? ENGL Copyright 2013 by Arthur Fricke “Informal” Reports Can be a few paragraphs to a few pages Generally provide information.
FYP2 Workshop: Technical Aspects of Thesis Writing and Seminar presentation Azizan Mohd. Noor UniKL MICET.
Book Report Guidelines Format n Be sure to follow THIS format for writing your report.
Unit 1 Activity 2B Communication Barriers Report
1 Report Writing Report writing. 2 Contents What is a report? Why write reports? What makes a good report? Fundamentals & methodology »Preparation »Outlining.
Preparation of a Research Report Literature review.
A PRESENTATION FOR THE THIRD YEAR - STUDENTS THE TECHNICAL HIGH SCHOOL OF EMIL KOLBEN IN RAKOVNÍK The Year Works.
 An article review is written for an audience who is knowledgeable in the subject matter instead of a general audience  When writing an article review,
Official business messages Professional approach
15 The Research Report.
Communicating Marketing Research Findings
Application Letters.
Preparing a Written Report Prepared by: R Bortolussi MD FRCPC and Noni MacDonald MD FRCPC.
Introduction to Professional Memo Writing
TABLE OF CONTENTS 2014 BasmahAlQadheeb. What is a report? A report is a clearly structured document that presents information as clearly as possible.
10 Informal Reports.
CERTIFICATE IV IN BUSINESS JULY 2015 BSBWRT401A - Write Complex Documents.
1 Module 8 Reporting Results. 2 Learning Objectives At the end of this session participants will:  Understand key points to effectively present results.
Technical Report Outline Title Page Frontispiece Abstract Table of Contents List of Figures/ List of Tables.
1. 1.To examine the information included in business reports. 2.To understand how to organize documents in order to ensure clear communication. 3.To analyze.
1 Report Writing with Citation and documentation Business and Human Communication BUS-201 BRAC Institute of Languages BRAC University.
“Copyright and Terms of Service Copyright © Texas Education Agency. The materials found on this website are copyrighted © and trademarked ™ as the property.
Project Report Format for Final Year Engineering Students.
Academic writing.
REPORT WRITING.
Department of Business Administration
Technical Report Writing
Technical Reading & Writing
Components of thesis.
Reports Chapter 17 © Pearson 2012.
Do’s and Don’ts Some good advice on creating a business plan.
Advanced Techniques in Report Writing
Chapter 21 Formal Reports
Writing reports Wrea Mohammed
Report Writing SIT - JNTU.
Writing a (Technical) report Communication skills B
Presentation transcript:

Writing a Technical report By Jan Bollen

Agenda Aim of report Use of report Not for all Structure, logical !!! Cover & title page Foreword Summary Table of contents Abbreviation list List of figures Company organisation Introduction Plan of approach Research Conlusions, your opinion References What to avoid, examples Excuses, Language style Presentation Graphs, Figures, Tables

Aim of report Transfer information Project Internship Final Thesis Connect to knowledge of reader Stimulate the reader for more …

Questions to the aim You have to know clear about what you tell What is the subject? What is the assignment? Who is your reader? How long can the report be?

Use of report Not everyone will read the whole report A summary can be read in a few minutes Key facts and conclusions should be very accessible

Not for all It will be impossible it to be equally easy for everybody Understood by decision makers Short report is better but difficult to make needs a perfect organization likely to be fully red

Structure, logical !!!! Logical, like a joke Good introduction Context and assignment Assignment plan Research Results and conclusions

Chapter structure Cover page Title page Foreword Company description Summary Table of content Abbreviation list List of figures Company description Introduction Plan of approach Method of research Research activities Results / Conclusions References Appendices

Cover & title page Logo’s company and Saxion Title & nice picture (cover page only) Authors' name and ID number Department and Course name Place and date of submission Title page = cover + extra information Addresses of University and company Copyright / Statement about confidential Signature student, company & Saxion

Foreword Written in 1st person. Why this report? For who? Information about author. Thanking of people.

Summary Accurate representation of the contents in an abbreviated form. Summarizes the whole report in 100-200 words. Decision Go /no go Read / no read

Summary content Assignment Method used Results Conclusion Recommendations Written after the report is complete

Table of Contents Organization of report. Chapters Sub-chapters Shows the logical structure Page numbers

Abbreviaton list Explanation of used abbreviations

List of figures tables symbols

Company organisation Type of company Product range Structure / organogram Amount employers

Introduction Represents the subject the purpose the assignment Introduce readers to the problem that you are setting out to solve in your technical report.

Plan of approach Main questions Sub questions Plan of approach Planning (Gannt)

Research Method of research Theory Application of theory Setup of research Test setup or simulation Executing of research Data Results / Graphs

Conclusions; your opinion Discuss what you Invented Discovered Confirmed Use Calculated values Visual observations, plots Illustrations, graphs, or tables.

References Opportunity to follow up your work. Literature Websites Materials Data / Specifications

References (examples)

What to Avoid Clichés and stock phrases Useless words Excuses Poems Computer program listings

Examples `at the end of the day...', `going forward, we will...' `at this point in time...‘ `in the opinion of the author...‘ These phrases add nothing to the content. They could be replaced by a single word. So use clear and direct language

Excuses !! Do not use statements about how difficult the work was how the report would have been better if the author had more time. People often say these sort of things in reports, and they don't look professional.

Language Style Check always grammar and spelling. Make short sentences. Use direct language. Style Formal, use 3rd person. (not I or you better it ) Switching between formal and informal is not acceptable !

Presentation Your report will be based to a large extent on the first impression made by the presentation. Consistency good structure Graphs and figures complete Margins and lay-out straight General appeal professional

Graphs

Figures Top-down Left right

Tables