Technical Report Writing

You might also like

Download as pptx, pdf, or txt
Download as pptx, pdf, or txt
You are on page 1of 8

Writing a Project

Report
Anissia Beainy- GNE301
 WHAT IS A PROJECT TECHNICAL REPORT?

Introduction  WHY DO I NEED ONE?


 HOW DO I WRITE ONE?
 A Technical REPORT:
 The purpose of a technical report is to completely and clearly
What is describe:
Technical 1. technical work and why it was done,
report? 2. results obtained and implications of those results.
 The technical report serves as a means of:
1. communicating the work to others and possibly providing useful
information about that work at some later date.
2. A well‐written report allows the reader to quickly understand
what has been accomplished.
3. The report also provides sufficient detail to allow the reader to
Why do I need recreate the results although the level of detail provided depends
heavily on the report’s audience and any proprietary nature of the
one? work.
4. Clear presentation of results is at least as important as the results
themselves; therefore, writing a report is an exercise in effective
communication of technical information.
5. To be meaningful to others, results must be supported by a
written explanation describing how results were obtained and
what significance they hold, or how a designed system actually
functions.
 The formal technical report contains a complete, concise, and well‐
organized description of the work performed and the results obtained.
 The pages of the report are to be assembled in the following order.
1. A TRANSMITTAL MEMO IS REQUIRED BEFORE THE TITLE PAGE IN
YOUR PROJECT REPORT.
2. Title page. always included: report title, who the report was prepared
for, who the report was prepared by, and the date of submission
How do I write 3. Abstract or Summary: An abstract is a concise description of the report
including its purpose and most important results. An abstract must not
one? be longer than half a page and must not contain figures or make
reference to them.
4. Table Of Contents.
5. Introduction and Background: Give the objective of the work, a brief
description of the problem, and how it is to be attacked. This section
should provide the reader with an overview of why the work was
performed. Include a discussion of relevant background theory with
appropriate citation of references related to this background.
1. Problem.
2. Scope or Aim. Explains in slightly more in details than your Proposal
the aims of your project.
3. Procedure: contains A. The description of your data and survey and
what inspired it. Next you details thoroughly your B. Data analysis
methods and how you will go on with them.
4. Conclusion: comprises you’re A. Findings and discussion of these
How do I write findings as per your data analysis and B. a Recommendation in the
end.
one? 5. Reference Section. List all works cited in the report, include all the
important bibliographical information
 The report should be written in an active voice using the third person in
most instances.
 Avoid using personal pronouns. Personal pronouns tend to personalize
the technical information that is generally objective rather than
subjective in nature.
 Use correct grammar, punctuation, and spelling.
 Attention to these details results in a professional tone to the report.
Example of  All diagrams must be neatly presented and should be computer
good practice. generated.
 Any information in the report that is directly quoted or taken from a
source must be cited using the proper notation.
 Any reference material derived from the web must come from credible
and documentable sources. Students need to evaluate websites critically.
 Wikipedia is NOT a credible reference because the information changes
over time and authors are not necessarily people with verifiable expertise
or credentials
TRANSMITTAL
MEMO

You might also like