Technical Report Briefing

8/11/2019 Technical Report Briefing

1/10

TECHNICAL REPORT WRITINGGUIDE

WAN SULAIMAN BIN WANMOHAMAD

FYP 2 COORDINATOR


2/10

What is Technical ReportTechnical reports are the primary written work products of

engineers. As such, they present facts and conclusions aboutdesigns, experiments, and other projects. They include researchabout technical concepts and often include visual depictions ofdesigns and data. A technical reports purpose is for an engineer

to communicate information gained through a process oftechnical or experimental work.


3/10

The title should be brief and meaningful and describethe contents of the report . The title identifies thesubject and indicates the purpose of the study. Thetitle page includes the title, authors name andsupervisors name.


4/10

The abstract should give a concise and clear overview ofthe entire project or topic to be discussed and should bethe main explanation of the entire report. Readers shouldbe able to gain all necessary information from the abstractand sometimes will read only this part. It should be

written in the third person, passive voice, and past tensebecause it explains work already done.

Abstract

A Good Abstractwill Include:

Brief introduction to the project The overall purpose of the project or principal

objectives. The problem to be studied. Simulation/Experimental methods and materials used. Main results. Main conclusions.


5/10

This section provides a context for the work discussed inthe report.Therefore, it: Gives sufficient background information to the report

(Literatures). Defines the project performed. Defines the scientific purpose or objective for the

experiment. Includes a description of the problem and reasons for

the work being done. Must answer the questions: Why was this study

performed? What is the specific purpose of the study?


6/10

Theory explains the technical background of the work. It usuallyincludes the mathematical equations, models, and formulae, aswell as the scientific relations in its final forms, which governsthe work, referenced to its original sources. If any derivationsare required or needed to backup the work, they are detailed inthe appendix and only the beginning and final relations arementioned in this part, with reference to the appropriatesection in the appendix. Any equations or models should beformatted and numbered according to the standards followed

in technical writing. It shows the methodology of the project inorder to accomplish the objectives set.

Theoretical Background (Methodology)


7/10

The results to the technical report should be analysed, interpreted and statedclearly. The use of figures and tables usually incorporated should have labelsreferenced in the text and fully explained and interpreted. Any errors should bediscussed and explained with regards to how they occurred and how theyaffected the conclusion. An error analysis is usually an essential part of thediscussion and provides a comparison to expected results. Data presented as

results should be well organized. Numerical data should be included in graphs ortables to provide the best possible information about the real situation. Thissection should answer the questions:

What do the results clearly indicate? What was discovered? What is the significance of the results? Are the results fully discussed and conclusions drawn based on the knowledge gained? How did errors occur? Did any of the errors affect the conclusion of the experiment/study?


8/10

This section should briefly summarize the significant results ofthe project. The conclusion: Must answer any questions raised in the introduction

regarding what was shown, discovered, verified, proved, ordisproved.

Must explain why the project is significant. Must explain the implications for your particular field of

study. Should not include discussion of new information not

already mentioned in the report.


9/10

References

Examples of references:

[1] M. K. Ghosh and A. Nagraj , Turbulence flow in bearings, Proceedings of theInstitution of Mechanical Engineers 218 (1), 61 - 64 (2004).

[2] H. Coelho and L. M. Pereira, Automated reasoning in geometry theorem

proving with Prolog, J. Automated Reasoning 2 (3), 329 -390 (1986).

[3] P. N. Rao, Manufacturing Technology Foundry, Forming and Welding, 2 nd ed.(McGraw Hill, Singapore, 2000), pp. 53 68.

[4] Hutchinson, F. David and M. Ahmed, U.S. Patent No. 6,912,127 (28 June2005).


10/10

Technical report information

4 12 pages

Technical Report Briefing

Documents

Transcript of Technical Report Briefing