1.4 ELEMENTS
• In reports we must back up our opinions with data, equations, drawings, etc. As a result we use a number of common items,
- figures
- tables
- equations
-
• When these elements are included, there MUST be a mention of them in the written text.
• These days it is common to cut and paste figures in software. Make sure
- the resolution is appropriate
- the colors print properly in the final form or print well as black and white
- the smallest features are visible
- scanned drawings are clean and cropped to size
- scanned photographs are clear and cropped to size
- digital photographs should be properly lit, and cropped to size
- screen captures are clipped to include only relevant data
1.4.1 Figures
• Figures include drawings, schematics, graphs, charts, etc.
• They should be labelled underneath sequentially and given a brief title to distinguish it from other graphs. For example “Figure 1 - Voltage and currents for 50 ohm resistor”
• In the body of the report the reference may be shortened to ‘Fig. 1’
• The figures do not need to immediately follow the reference, but they should be kept in sequence. We will often move figures to make the type setting work out better.
• If drawing graphs by computer,
- if fitting a line/curve to the points indicate the method used (e.g. linear regression)
- try not to use more than 5 curves on the same graph
- use legends that can be seen in black and white
- clearly label units and scales
- label axes with descriptive term. For example “Hardness (RHC)” instead of “RHC”
- scale the curve to make good use of the graph
- avoid overly busy graphs
1.4.2 Tables
• Tables are often treated as figures.
• They allow dense information presentation, typically numerical in nature.
Table 3: A Comparison of Toy Vehicle Properties
|
Description
|
Number
|
Color
|
Shape
|
Material
|
|
car
|
3
|
red
|
rectangular
|
die cast
|
|
truck
|
6
|
blue
|
long
|
polyprop.
|
|
motorcycle
|
2
|
green
|
small
|
wood
|
• Legends can be added to tables to help condense size.
1.4.3 Equations
• When presenting equations, use a good equation editor, and watch to make sure subscripts, etc are visible.
• Number equations that are referred to in the text.
• Box in equations of great significance.
1.4.4 Experimental Data
• When analyzing the results from an experiment there are a few basic methods that may be used,
Percent difference -
Mean and standard deviation -
Point by point -
Matching functions -
etc......
XXXXXXXXXXXXXX Add more XXXXXXXXXXXXXXXXX
1.4.5 References
• References help provide direction to the sources of information when the information may be questioned, or the reader may want to get additional detail.
• Reference formats vary between publication sources. But, the best rule is be consistent.
• One popular method for references is to number them. The numbers are used in the body of the paper (eg, [14]), and the references are listed numerically at the end.
• Another method is to list the author name and year (eg, [Yackish, 1997]) and then list the references at the end of the report.
• Footnotes are not commonly used in engineering works.
1.4.6 Acknowledgments
• When others have contributed to the work but are not listed as authors we may choose to recognize them.
• Acknowledgments are brief statements that indicate who has contributed to a work.
1.4.7 Appendices
• When we have information that is needed to support a report, but is too bulky to include, one option is to add an appendix.
• Examples of appendices include,
- reviews of basic theory
- sample calculations
- long tables of materials data
- program listings
- long test results
