how to write a technical report powerpoint: h venterspeakers: l kruger editor: gf de wet g claassen...
TRANSCRIPT
![Page 1: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/1.jpg)
How to write a technical
reportPowerpoint: H Venter Speakers: L Kruger
Editor: GF De Wet G Claassen
Group 42
![Page 2: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/2.jpg)
Technical ReportTechnical Report(definition) (definition)
A technical report is a document that:
• present facts and conclusions about a project
• contains technical concepts and graphical depictions of designs and data
![Page 3: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/3.jpg)
Technical ReportTechnical Report(Who needs it?)(Who needs it?)
• Engineers: designing or modifying a project
• Technicians: implementing designs • Researchers: organized reference • Any other profession in need of
organised technical descriptions of large projects
![Page 4: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/4.jpg)
Technical ReportTechnical Report(Why is it needed?)(Why is it needed?)
• Strict organization • To make sure all parties involved use
the same data when using or modifying a project
![Page 5: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/5.jpg)
Tips for Gathering DataTips for Gathering Data
• It starts before the project starts• Visualize• Gather for purpose of publication• Gather honestly• Record rough ideas and prospects• Work neatly and document everything
![Page 6: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/6.jpg)
Analysing DataAnalysing Data
• Choose relevant data• Guide reader to conclusions• Avoid repetition of data• Ideas should not be repeated• Don’t say the same thing twice
![Page 7: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/7.jpg)
Analysing Data (2)Analysing Data (2)
• Decide on significant digits• Do not mix units• Limiting Sentence:
Subject: Can women drive?
Scope: Includes high speed,parkingand emotional stability tests.
Reason: To improve road safety.
• Helps to focus point of report
![Page 8: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/8.jpg)
Title pageTitle page
• Contains a title, author and date
• The page should be descriptive and not too long
![Page 9: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/9.jpg)
• States the report instructions
• Contains administrative information
Terms of referenceTerms of reference
![Page 10: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/10.jpg)
AbstractAbstract
• Helps the reader to decide what to read and what is relevant to his needs
• Overviews report structure, main topic, conclusions
• Can be separate from report
![Page 11: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/11.jpg)
Table of contentsTable of contents
• list of headings and subheadings with page numbers
• outline the report structure
• helps the author of the report to structure his report during initial stages of the report
![Page 12: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/12.jpg)
Table of contentsTable of contents(example)(example)
![Page 13: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/13.jpg)
• Helps the reader to quickly locate tables, data sheets, graphs, etc.
List of figures and tablesList of figures and tables
![Page 14: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/14.jpg)
GlossaryGlossary
• Abbreviations and special technical terms used in the report are explained
![Page 15: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/15.jpg)
The report bodyThe report body(introduction)(introduction)
• Give the industrial, economical, or technological background to the report
• Outline the approach of argument that the report will take
![Page 16: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/16.jpg)
The report bodyThe report body(main section)(main section)
• The report body consists of sections and subsections regarding the report topic.
• Contains tables, data sheets, graphs, etc.
![Page 17: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/17.jpg)
The report bodyThe report body(example)(example)
1. Topic 11.1 Subsection 11.2 Subsection 2
2. Topic 22.1 Subsection 12.2 Subsection 2
![Page 18: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/18.jpg)
The report bodyThe report body(conclusion)(conclusion)
• It is usually short since technical reports consists mainly of technical specifications and not opinions
![Page 19: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/19.jpg)
Bibliography Bibliography
• gives credit to all sources referenced in report
![Page 20: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/20.jpg)
AppendixAppendix
• The appendix is placed at the end of a report
• Appendices are labeled alphabetically e.g. Appendix A
• It contains:• all data that may handicap the natural
flow of the report, e.g. tables,data sheets, graphs, etc.
![Page 21: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/21.jpg)
Requirements - ClarityRequirements - Clarity
• Convey exact unambiguous meaning• Define mathematical symbols clearly• Remember that you are over familiar• Readers won’t tolerate confusion• One chance to sell objectives
![Page 22: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/22.jpg)
Requirements - ContinuityRequirements - Continuity
• Tell story – logical and interesting• Requires continuity between
sentences,paragraphs and sections• Especially between text and graphics• Don’t refer to something you haven’t
explained yet
![Page 23: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/23.jpg)
Requirements – ObjectivityRequirements – Objectivity
• Should be objective and show restraint.
• Be absolutely honest.• Do not try to hide deficiencies.• “No report is better than the project
of research it’s based on.”• State errors and what you don’t
understand about results.• “Write to express not to impress.”
![Page 24: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/24.jpg)
Writing Style – Writing NaturallyWriting Style – Writing Naturally
• Personal style secondary to understanding
• Still, try to write to excite and enjoy• Keep to sentences that come
naturally• Avoid impressing with large
vocabulary• Write in the present tense, and in the
third person
![Page 25: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/25.jpg)
Guiding the readerGuiding the reader
• Tell them what you’re going to tell them (introduction / abstract)
• Then tell them (main body)• Tell them what you’ve told them• Remember to choose data to guide
readers to conclusions
![Page 26: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/26.jpg)
Getting to the pointGetting to the point
• Not a mystery novel• Get to the point as quickly as
possible• Don’t use blind alleys for effect• Appendix – good way to bring up
points that will be interesting to some users.
![Page 27: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/27.jpg)
Separating fact from opinionSeparating fact from opinion
• Don’t overlap discussions of results with conclusions
• Alert readers when starting with fact or opinion:
• “From these results I conclude that..”
![Page 28: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/28.jpg)
Data RepresentationData Representation
• Tables – Exact values
• Least preferred way to represent data• Sometimes hard to grasp significance• Try to keep tables short• If possible rather use words• Keep lengthy tables separate
![Page 29: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/29.jpg)
Data RepresentationData Representation
• Graphs – relative trends
• Clear and simple• As few data curves as possible• As few labels as possible• Keep equations in the text• Choose coordinates to give a physical
feel
![Page 30: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/30.jpg)
SummarySummary(1)(1)
Definition and applications of a technical report
Data:– gathering– analysis– representation
![Page 31: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/31.jpg)
SummarySummary(2)(2)
Different parts of report– Title page
– Terms of reference
– Abstract
– Table of contents
– List of illustrations
– Glossary and list of symbols
– …
![Page 32: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/32.jpg)
SummarySummary(3)(3)
Style Requirements– Clarity– Continuity– Objectivity
Writing Style– Writing naturally– Guiding the reader– Getting to the point– Separate fact from opinion– Data representation
![Page 33: How to write a technical report Powerpoint: H VenterSpeakers: L Kruger Editor: GF De Wet G Claassen Group 42](https://reader030.vdocument.in/reader030/viewer/2022032612/56649ec15503460f94bcc695/html5/thumbnails/33.jpg)
How to write a technical
reportPowerpoint: H Venter Speakers: L Kruger
Editor: GF De Wet G Claassen
Group 42