Scribd
Upload
21 views19 pages

P1 Report Writing format

The document outlines the importance of report writing in engineering, detailing its role in communication, documentation, and assessment of work. It provides a comprehensive layout for reports, including sections like the cover page, acknowledgments, abstract, and references, along with formatting guidelines. Additionally, it emphasizes proper citation methods to avoid plagiarism and the necessity of proofreading and spell-checking the document.

Uploaded by

Sizwe Fanele
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
21 views19 pages

P1 Report Writing format

The document outlines the importance of report writing in engineering, detailing its role in communication, documentation, and assessment of work. It provides a comprehensive layout for reports, including sections like the cover page, acknowledgments, abstract, and references, along with formatting guidelines. Additionally, it emphasizes proper citation methods to avoid plagiarism and the necessity of proofreading and spell-checking the document.

Uploaded by

Sizwe Fanele
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 19

Report Writing

Prepared and Presented by Nkosinathi Mokwena


Why Do We Write Reports?

• Effective method of communicating engineering


work.
• To document the execution of engineering work.
• To highlight important/relevant information to the
audience.
• A means of assessing the value that you add to the
company
General Report Layout

• Cover Page
• Acknowledgements
• Declaration
• Abstract
• Abbreviations (optional)
• Table of Contents
• Table of Figures

• Introduction
• Main Body
• Conclusions
• References

• Appendix (if Required/Optional)


Cover Page

A cover page must include the following:

• Company Name
• Workshop
• Date
• Name and Surname
• Student Number and Institution
• Instructor and Assistant Instructor Name
Acknowledgments

• This is reserved for the author to thank individuals for


their support in conducting the research or tasks presented
in the document.

• Gratitude must be extended to all individuals who have


contributed to the success/execution of the tasks carried
out.

• Must be included on its own page.


Declaration

• A written public announcement of intentions or of the terms of an agreement.


• Must be on it’s own page.
• Example:

I hereby declare that the logbook report submitted as partial


requirement for WIL is my original work and has not previously been submitted to
any other organisation, or institution of higher learning. I further declare that all
sources cited or quoted are indicated and acknowledged by means of a
comprehensive list of references.

Student/Intern Signature:
Date:
Abstract

• This section should give any reader a short overview of what


the work is about and how it was done.

• It allows the reader to quickly ascertain the purpose of the


document.

• It should include part of your introduction, body and your


results and conclusions.

• It should not exceed a length of one page.

• Should be on its own page


Table of Contents/Figures

• A list of all headings (and sub-headings) present in your document.


• (A list of all figures presented in the report).

• Must be on its own page/s.

• Must indicate page number next to content.


Introduction

• Introduces the work carried out.

• Provides a background information to understanding the work


that is covered in the report

• May also include a literature review, providing support for the


work conducted.
MAIN BODY

• Main content of the report.


• Varies from workshop to workshop i.e.
• 2. Workshop Rules and Safety
• 3. Instruments
• 4. Components
• 5. Assignments
• 5.1. Assignment 1:……
• 5.1.1. Aim
• 5.1.2. Objectives
• 5.1.3. Apparatus
• 5.1.4.Circuit Diagram
• 5.1.5. Procedure
• 5.1.6. Calculations
• 5.1.7. Results and Observations
• 5.1.8. Summary
CONCLUSIONS

• Summarises the contents of the report.

• Highlight the work done and the results obtained.

• Implicitly includes recommendations


REFERENCES

• Used to acknowledge work that is not your own.


• Two Methods often employed in Engineering Reports

1. IEEE Referencing Method

• In-text Citation:
• “According to [1]…..”
• [1,3,4,5 and 7]
• [1-4]

• Reference list citation


• [1] B. Klaus and P. Horn, Robot Vision. Cambridge, MA: MIT
Press,1986
REFERENCES

2. Harvard Referencing Method

• In-text Citation:
• “As stated in (Doss 2003)…..”

• Reference list citation:


• Doss, G., 2003, IS project management handbook, Aspen
Publishers, New York.

• Plagiarism:
• Do not Copy and Paste; Convert to your own
words/understanding
• Reports submitted through turnitin.
APPENDIX

• A section reserved for additional information.

• APPENDIX A: PIC16F690 Datasheet; ADC Module

• APPENDIX B: Resistor Colour Coding Chart


GENERAL REPORT FORMAT

Font:
• Use of a legible font e.g. Times New Roman
• For Headings font size 16, Bold
• For Sub-headings font size 14.
• Normal Text font size 12.

Text Alignment and Line Spacing:


• Text Alignment Justified
• Line spacing 1.5
GENERAL REPORT FORMAT
Abbreviations:

• Include a section between Declaration and Table of


Contents listing all abbreviations in order of
appearance.

• Firstly state the complete name along with


abbreviation in brackets. Any occurrence thereafter
can utilise the abbreviation. E.g - Programmable
Logic Controller (PLC)

Page Numbers
• Always include page numbers.
• Start numbering at 0.
GENERAL REPORT FORMAT
Borders:
• Unless stated otherwise, do not include border
frame on the document.
Proof Read and Spell Check:
• Spell Check is free please use it.
• Proof Read your Document (Back to front and
Front to back)
Figures and Captions:
• Crop the figure to an acceptable size.
• Centre the figure
• Insert a caption for each figure.
• Introduce image before displaying.
• Discuss/Describe the figure following.
Tables and Headings:
• Tables to be centred
• Heading located above table
Any Questions??
THANK YOU

You might also like