Embed Size (px)
DESCRIPTION
Engineering Report Organization. 1) title page 2) abstract or executive summary 3) front matter 4) introduction 5) technical sections 6) conclusions 7) appendices. Title Page. Title (not too long) Names Section and Team Number Name of class/instructor Term (Fall 2011) Date - PowerPoint PPT Presentation
Citation preview
1
Engineering Report Organization
1) title page2) abstract or executive summary3) front matter4) introduction5) technical sections6) conclusions7) appendices
2
Title Page
Title (not too long) Names Section and Team Number Name of class/instructor Term (Fall 2011) Date Auburn University
3
Abstract
100-200 words summarize main conclusions of report
In a longer engineering report, an abstract or executive summary can be up to one page long but never longer.
4
Front Matter
Table of contents List of figures Nomenclature
» V - voltage» n - motor speed (rpm)» etc.
5
Introduction
Problem statement Background (history, relevant information) Summarize approach Outline remainder of report
6
Technical Sections
Alternatives» discuss each category» specify options
Choice of present design» discuss each category» present and interpret data» draw conclusions
7
Lego Car Design Output voltage
» Higher output voltage increases speed» Penalties apply above 10V
Power supply (batteries)» One 9V battery (light, but less than 10V)» Two 9V batteries (≥10V, but heavy)» Watch batteries (very light, but drain quickly)
Wheel size and gears» Torque vs. speed tradeoff
Drive strategy» Front wheel vs. rear wheel drive
Course path» Passing through all gates vs. missing gates» Pushing block vs. not pushing block
Body» Light vs. heavy
8
Technical Sections
Detailed design presentation Include descriptive material in relevant
location.» Long lists or tables should be referred to an
appendix.» All descriptive material should be referenced or
discussed.» Specifications/drawings/parts/cost
9
Technical Sections
Performance (Final Design Report Only)» Predicted» Actual» Explain any differences
10
Conclusions
What was discovered» technical information obtained» NOT information learned about the class
11
Appendices
Use for material that few people would read in its entirety» long tables» long calculations» detailed specifications
12
Engineering Reports Report organization Writing style Professional tone Figures and tables
13
Writing Style Short paragraphs
» Introduce your point (Topic position)» Support your point» Drive your point home (Stress position)
Write like a journalist» Newspapers» Magazines
14
Writing Style
Use short sentences.» Bad:
“In lab, we found that a bridge rectifier generated a slightly faster completion time than a half-wave rectifier, but, taking into consideration the penalty for use of extra parts, we decided to use a half-wave rectifier.”
15
Writing Style
» Better:“In lab experiments, a bridge rectifier generated a
slightly faster completion time than a half-wave rectifier. A half-wave rectifier, however, actually yielded a faster time once the penalty for extra parts was considered.”
16
Paragraph Too Long
When the force of sound waves implode tiny bubbles within a liquid at room temperature, the surface of the bubble can reach temperatures at least 25,000 degrees Fahrenheit, more than twice as hot as the surface of the sun, scientists reported this month. The center of such a bubble may be even more astonishingly hot. The scientists, at the University of Illinois, did not speculate just how hot the bubble became, but said they had managed to create a state of matter called plasma inside the bubble. In it, some of the electrons have been stripped off the atoms. "This is the first definitive proof of the existence of a plasma" during this kind of bubble implosion,” said one of the scientists, Dr. Kenneth S. Suslick, a professor of chemistry at Illinois.
17
Short ParagraphsWhen the force of sound waves implode tiny bubbles within a liquid at room temperature, the surface of the bubble can reach temperatures at least 25,000 degrees Fahrenheit, more than twice as hot as the surface of the sun, scientists reported this month.
The center of such a bubble may be even more astonishingly hot.
The scientists, at the University of Illinois, did not speculate just how hot the bubble became, but said they had managed to create a state of matter called plasma inside the bubble. In it, some of the electrons have been stripped off the atoms.
"This is the first definitive proof of the existence of a plasma" during this kind of bubble implosion, said one of the scientists, Dr. Kenneth S. Suslick, a professor of chemistry at Illinois.
18
Formatting Tips
Bad Example
Try to use lists, bullets, and headers as much as you can. Text that runs together in long, drawn-out paragraphs can be hard to follow. It is also hard to see the main points. Furthermore, it makes it difficult to scan quickly for specific points of interest.
19
Exploit lists, bullets, and headers Paragraph format:
» can be hard to follow. » hard to see the main points. » difficult to scan for specific points of interest.
Formatting Tips -- Better Example
20
Engineering Reports Report organization Writing style Professional tone Figures and tables
21
Professional Tone
Don’t make vague assertions.
“We decided to use 12 gauge wire. The 12 gauge wire is efficient for its size. It will conduct enough electricity and not add too much weight to the car. It also offers
a low amount of resistance.”
22
Professional Tone
Less vague:
“We decided to use 12-gauge wire. As seen in Table 3, electrical resistance is proportional to wire gauge. Weight is inversely proportional to wire gauge. 12-
gauge wire provided the best tradeoff between weight and electrical resistance.”
23
Professional Tone
A report isn’t a diary or a blog.NO:“We tried a half-wave rectifier at first, but then
we put a capacitor in parallel with the circuit and found that the average speed increased.”
YES:“A capacitor in parallel with a half-wave
rectifier gave the highest average speed.”
24
The design project is to build a small vehicle from Legos parts powered by the output of a PC sound card. You will select a waveform to play through the sound card, which will then be amplified by an audio amplifier and delivered to the vehicle.
Separate left and right channels will be available so that steering can be accomplished through the balance control on the PC volume control user interface. Circuits will be designed to convert the audio signals to signals that drive the car motors. The goal is to build a vehicle that can complete a race course in the shortest time possible.
Professional Tone
The report should have a consistent, professional-looking format throughout.
25
Professional Tone No handwritten marks anywhere!* No hand-drawn figures, unless of
exceptionally high quality. Addressed as one professional to another,
not student to instructor. Don’t use contractions.*Exceptions may apply.
26
Professional Tone Avoid expression of feelings. Just state
facts.NO: “We feel that an 18-gauge wire
provides the best tradeoff…”YES: “Our simulations showed that an
18-gauge wire provides the best tradeoff…”
27
Professional Tone
Support all assertions with data if it is available.
Types of data» Simulation results» Experimental measurements
28
Example
“A capacitor in parallel with a half-wave rectifier gave the highest average speed.”
29
Better
“Table 2 shows the average speed around a 10m track for several rectifiers. A capacitor in parallel with a half-wave rectifier gave the highest average speed.”
30
Engineering Reports Report organization Writing style Professional tone Figures and tables
31
Figures and Tables Number each figure or table
» Figure 1, Figure 2, etc.» Table I, Table II, etc.
Give each figure/table a caption» Give basic information about the figure/table» Figure captions go below a figure» Table captions go above a table
32
Figures and Tables Refer to the figure/table in the text
» Do not make the reader find the figure/table on his/her own!
In the text:» Describe what the figure/table means or represents» Describe how the numbers in the figure/table were
generated» Describe any conclusions you draw from the
figure/table.
33
Bad Example
20
25
30
35
40
45
50
10 12 14 16 18 20 22 24 26 28 30
Wire Gauge
Cour
se C
ompl
etio
n Ti
me
(sec
.)
SAMPLE
34
Good Example
20
25
30
35
40
45
50
10 12 14 16 18 20 22 24 26 28 30
Wire Gauge
Cour
se C
ompl
etio
n Ti
me
(sec
.)
Figure 1. Simulated course completion times
versus wire gauge.
The effect of wire gauge on the course completion time was studied by simulating the circuit in Appendix A using PSpice. Figure 1 shows the simulated course completion times for wire gauges 10-30. 20 gauge wire results in the fastest completion time because it is the best tradeoff between wire resistance and wire weight.
SAMPLE
