7/29/2019 Lab Rep t Writing 2011
1/57
MAE 171A
Mechanical Engineering Laboratory
Lecture Notes
January 2009
Laboratory Report Writing
2011
7/29/2019 Lab Rep t Writing 2011
2/57
2
Introduction to lab report writing
z Concepts related to readers and writers
JWhy are you writing this document?The goals are to persuade, inform and document
The academic purpose is the display of knowledge
z Concepts related to textJFeatures ofContent
OrganizationLanguage
Format
determined by your audience and your purpose
7/29/2019 Lab Rep t Writing 2011
3/57
3
Concepts related to textz Content
J the information contained in your documentz Organization
J How the information is organized within the document
J Paragraph organization
J Sentence organization in the paragraphz Language
J Grammatical structures appropriate
J Concise language
JAppropriate word choiceJ Error-free language
z Format
J Refers to the general appearance of the document
J Informative headingsJ Fonts used, bullets, bold, italics, etc.
7/29/2019 Lab Rep t Writing 2011
4/57
4
7/29/2019 Lab Rep t Writing 2011
5/57
5
Writing as one of a team
z If different people are writing different
sectionsJOne person should edit the final draft (a good
report may come after many drafts)
z Team writing needs careful planningz Groups should agree on the outline of the
report before drafting starts
z All the authors should read and approvethe final version, each of them isresponsible for the entire document
7/29/2019 Lab Rep t Writing 2011
6/57
6
The writing process
z Pre-writing
JGenerate ideas and organizing them via outlining, freewriting and/or concept maps
z Writing
JPrepare draft to be compiled with the rest of the reportfor team members to review
z RevisingJEach team member should have recommendations for
changes in content, organization, language and format
z EditingJReviewing the document for mechanical errors, unclear
sentences, language that is not concise or isungrammatical
7/29/2019 Lab Rep t Writing 2011
7/57
7
The writing process - outline
First thing to do is outline your report
JWrite each heading at the top of a sheet ofpaper
JWrite all the points you can think of under each
headingJFind all your notes, figures, tablesIt is very important to write every importantdetail of
the experimentJSort these out and put then with relevant
section
7/29/2019 Lab Rep t Writing 2011
8/57
8
Structure of your laboratory report
z All pages must be numbered
z All figures and tables must have legends thatdescribe themJYou should be able to look at a figure and table and
understand what is being shown without having torefer to the text.
z All references must be fully cited in referencesections
z No verbatim quotes allowedJ Such as:
Arnez stated in 1998 that Fracture mechanics is a method for predicting failure of astructure containing a crack. It uses methods of analytical solid mechanics to calculate thedriving force on a crack and those of experimental solid mechanics to characterize the
material's resistance to fracture. and this definition was used.
7/29/2019 Lab Rep t Writing 2011
9/57
9
Structure of laboratory report
z 20 page maximum
JIncluding text, figures and tables
JDouble-spacedExcept for figure and table captions
J1 inch margins around each page
JUse 12 point Times orTimes New Roman font or11 point Ariel orGeorgia font
z Do NOT use a double-column page format(use single column)
z Appendix to include raw data.
7/29/2019 Lab Rep t Writing 2011
10/57
10
z Title page separate sheet
z Abstract separate sheetz Table of contents separate sheet
z List of tables separate sheet
z List of figures separate sheet
z
Introductionz Theory
z Experimental procedures
z Experimental results
z Discussion of results
z Conclusions
z Error analysis (can be part of discussion)
z References separate sheet(s)
z Appendices and raw data separate sheet(s)
The structure of your laboratory report must havethese major headings
20 pagesmaximum
including
figures
and tables
7/29/2019 Lab Rep t Writing 2011
11/57
11
Title page
z The title answers the question
JWhat is the report about?
z The title should be
JInteresting
JConcise
JInformative
JAccurateInclude all group members, group number, grouptime
7/29/2019 Lab Rep t Writing 2011
12/57
12
Title page example
Water Tunnel
Measurement of the Drag Coefficient of a Cylinder(no words can be removed!)
Presented to the
University of California, San Diego
Department of Mechanical and Aerospace Engineering
MAE 171A
Date
Prepared by:
Group X, Section A0X, Thursday afternoon
Names of group members
7/29/2019 Lab Rep t Writing 2011
13/57
13
Abstract
z Is an abbreviated, accurate representation of the
content of the reportJUsually one paragraph
Why the experiment was done
How the experiment was performed
What pertinent results were obtained
Conclusion obtained from data analysis
Informative, quantitative, short, concisely written
z Do not refer in the abstract to information that isnot in the report
z Use the third person
z Write this section LAST!
7/29/2019 Lab Rep t Writing 2011
14/57
14
Table of contents
z Each heading (see slide 10) must be
listed
z Each heading must have a page
number
List of FiguresList of Tables
Introduction
Page
45
6
Table of Contents
7/29/2019 Lab Rep t Writing 2011
15/57
15
List of figures
z Figures should be in numerical order,
using the same legend as what is on
the figure
z Figures need a page numberFigure Description
1 Variation of the elastic modulusas a function of temperature
Page number
4
7/29/2019 Lab Rep t Writing 2011
16/57
16
List of tables
z Tables should be in numerical order,
using the same legend as what is on
the figure
z Tables need a page numberTable Description
1 Fracture toughness values as afunction of tip radius for
polycarbonate
Page number
6
7/29/2019 Lab Rep t Writing 2011
17/57
17
Introduction
z Statement of the problem
JWhy did you do this work?
JWhat is its purpose?
JWhy is it important?
z Tell the readers briefly what you examined
z Indicate your experimental approach
z Cite published workJWho has studied this in the past and what
results did they obtain?
7/29/2019 Lab Rep t Writing 2011
18/57
18
Introduction
z Indicate the need for testing/experimental analysis
JIncludeA statement of the problem that is being investigated and any
sub-problems or
A question that needs to be answered about the phenomenon
under studyz Answer the need for testing/experimental analysisJInclude
The method you'll employ to answer the question or solve the
problem identified (i.e., What are you going to do?)A description of the specific objective of the experiment (i.e.,
What are you going to do?)
A statement of what will be covered in the report
7/29/2019 Lab Rep t Writing 2011
19/57
19
Introduction editing worksheetArea Question Y/
NComments
Content 1. Does the writer establish identify the
phenomenon studied and state itsimportance to the field of engineering?
2. Does the writer avoid excessivediscussion of real-world applications?
3. Does the writer clearly state theobjectives of the experiment?
Organization 1. Does the introduction appear to beclearly organized?
2. Does the writer avoid unnecessarilylong paragraphs?
Language 1. Does the writer put old informationbefore new information?
2. Does the writer use concise butspecific language?
3. Does the writer avoid mechanical and
grammatical errors?
7/29/2019 Lab Rep t Writing 2011
20/57
20
Theory
z Summarize the key theory concepts that are beingused, examined, or tested in the experimentJAlso summarize key theory equations used in data
analysis
z Clearly state assumptions that are used in theory
z Point out possible regimes where assumptionsmight be violated in experiment
z Use figures or schematics as appropriatez Cite relevant references to guide readers who
need or want additional information
7/29/2019 Lab Rep t Writing 2011
21/57
21
Experimental procedurez Apparatus/Experimental
apparatus namemodel numbers (serial numbers not necessary)
clearly-labeled diagrams
relevant measurements of items related to apparatus
table of experimental equipment used (refer to this in procedure,but place table in appendix),
UCSD-made equipment receives a descriptive name, and itsorigin (UCSD) is mentioned. (dept. requirement).
z Procedure - step by step organizationProcedure should be explained in enough detail to allowanother researcher to duplicate your experiment.
Carefully document the conditions of your experiment
Calibrations used
Methods used to obtain data
7/29/2019 Lab Rep t Writing 2011
22/57
22
Procedure editing worksheetArea Question Y/N Comments
Content 1. Does the writer state the locationof the experiment?
2. Does the writer describe theapparatus or experimental setup?
3. Is the procedure described inenough detail, without adding
irrelevant information?
Organization 1. Are there enough informativeheadings?
2. Does the section have clear
paragraphs covering one topic?
Language 1. Does the writer avoid the use of"we" and use the passive voice?
2. Does the writer avoid mechanical
and grammatical errors (e.g.,dangling modifiers)?
7/29/2019 Lab Rep t Writing 2011
23/57
23
Resultsz You are answering the question
JWhat did you find and see?z Write this section so that it stands on its own
z Emphasize results that answer the question(s) you are
examiningz Put secondary results after primary ones
z Dont repeat in the numbers that are presented in the
tables and figures in the textz Dont repeat the table and figure titles in the text
z Include error analysis
7/29/2019 Lab Rep t Writing 2011
24/57
24
Results editing worksheetArea Question Y/N Comments
Content 1. Does the writer use a locationelement/summary (with figure number(s))
to introduce a figure?
2. Are appropriate results highlighted?(i.e., those specified in the lab handout)
3. Are appropriate explanations of resultsprovided, without going into detail aboutlarger conclusions?
Organization 1. Are enough informative headingsused?
2. Does the section have clearparagraphs covering one topic?
Language 1. Does the writer use a variety of verbsin the location summaries (e.g., shows,indicates, provides, etc.)
2. Does the writer use concise butspecific language?
3. Does the writer avoid grammatical and
mechanical errors?
7/29/2019 Lab Rep t Writing 2011
25/57
25
Discussion
z In this section you are answering the question
JWhat do your findings mean?
z This section is where you answer specific
question(s) you stated in the introduction
z Discuss errors in your methods and assumptions
z Avoid the temptation to refer to every detail of your
work again
7/29/2019 Lab Rep t Writing 2011
26/57
26
Discussionz Restatement of significant results in a more
general format, thenJCiting agreement or disagreement with theory
JCiting agreement or disagreement with previous studies
JAdmitting difficulties in interpretation
JPointing out discrepancies
JTry to explain anomalous results
JCommentary on whether results are expected or
unexpectedJCommentary about the significance or implications of
the results
7/29/2019 Lab Rep t Writing 2011
27/57
27
Options for opening the Discussion
sectionz General conclusion
JApparently, the area is in the early phases of a classic populationexplosion
z Restatement of the original purposeJ The objective of the survey was to quantify the number of
.within
z SummaryJ This report brings together all known records of . since 1959.
z Mention of theory
J The results obtained from this experiment would appear tosupport the theory which states that
z Use the last sentence of your introduction (if appropriate)
7/29/2019 Lab Rep t Writing 2011
28/57
28
Discussion - limitations of research
scope
z This experiment has tested
z The results of this experiment address
only the question ofz This analysis has concentrated on
z The results of this experiment arerestricted to
7/29/2019 Lab Rep t Writing 2011
29/57
29
Verbs often used in the discussion
section
show revealprovide display
give demonstrate
present indicate
summarize suggest
illustrate
7/29/2019 Lab Rep t Writing 2011
30/57
30
Discussion editing worksheetArea Question Y/
NComments
Content 1. Does the writer use points instead offacts (e.g., explanations, interpretations,
conclusions)
2. Does the writer discuss the majorlimitations of the experiment?
3. Are all of the major trends/conclusionsmade?
Organization 1. Is the organization of the section(minor conclusions to major conclusionsor major to minor) logical?
2. Does the writer use enoughinformative headings?
Language 1. Does the writer use concise butspecific language?
2. Does the language "flow"; i.e., doesthe writer put old information before new?
2. Does the writer avoid grammatical andmechanical errors?
7/29/2019 Lab Rep t Writing 2011
31/57
31
Conclusions
z Some readers will only read the conclusions
z Conclusions should be succinct and are astatement of your main findings
z Conclusions should contain strong verbs
JUse show and indicate
z Identify speculation by using might with the
verbz After the conclusions
JAt the end, acknowledge briefly any substantial
help
7/29/2019 Lab Rep t Writing 2011
32/57
32
Referencesz Use the AIAA format for references
z References must be easily accessible in libraries or otherpublic sources.
z They are to be numbered in the order in which they are
cited in the text.
z Use references to ASTM standards, e.g.,
JD 5045-99 (Reapproved 2007) Standard Test Methods for Plane-
Strain Fracture Toughness and Strain Energy Release Rate of
Plastic Materials
JD 2990-01 Standard Test Methods for Tensile, Compressive, and
Flexural Creep and Creep-Rupture of Plastics
7/29/2019 Lab Rep t Writing 2011
33/57
33
Importance of Testing Standardsz Army recalls 16,000 body armor sets amid
testing dispute (CNN, January 28, 2009)z Secretary of the Army disagrees with Defense
report citing flawed test procedures
z Army and inspector general at odds over atesting step called "first article testing
z Recall represents only about 1.6 percent of the
1.9 million sets in use since 2001
7/29/2019 Lab Rep t Writing 2011
34/57
34
Reference formattingz Journals
JWalker, R. E., Stone, A.R., and Shandor, M.,"Secondary Gas Injection in a Conical Rocket Nozzle,"AIAA Journal, Vol. 1, No. 2, 1963, pp. 334-338.Note: Title of article is in quotation marks and name of journal is
italicized.z BooksJTurner, M.J., Martin, H.C., and Leible, R.C., "Further
Development and Applications of Stiffness Method,"
Matrix Methods of Structural Analysis, 1st ed., Vol. 1,Wiley, New York, 1963, pp. 6-10.Note: This is an article published in a book containing a
collection of articles. The title of the book is italicized, and the
title of the article is given in quotation marks.
7/29/2019 Lab Rep t Writing 2011
35/57
35
Reference formattingz Book Series
JSutton, K., "Air Radiation Revisited," Thermal Design ofAeroassisted Orbital Transfer Vehicles, edited by H.F. Nelson, Vol.96, Progress in Astronautics and Aeronautics, AIAA, New York,1985, pp. 419-441.
z Reports
JBook, E., and Bratman, H., "Using Compilers to Build Compilers"Systems Development Corp., SP-176, Santa Monica, CA, Aug.1960.
z Transactions/Proceedings
JSoo, S.L., "Boundary-Layer Motion of a Gas-Solid Suspension,"Proceedings of the Symposium on Interaction Between Fluids andParticles, Vol. 1, Inst. of Chemical Engineers, New York, 1962, pp.50-63.
7/29/2019 Lab Rep t Writing 2011
36/57
36
Reference formattingz Meeting Papers
JBhutta, V.A., and Lewis, C.H., "Aerothermodynamic Performance of3-D and Bent-Nose RVs under Hypersonic Conditions," AIAAPaper 90-3068, Aug. 1990.
z AIAA does not give a format for the citation of Web pages.The American Psychological Association publication
manual, which is widely used in the social sciences,provides guidelines for citing Web pages. A modifiedversion which you may find helpful is provided below.
z Web pagesJAuthor, I. (date). "Title of article." Name of periodical[Online].
Available: Specify path. Accessed on: date of access.
7/29/2019 Lab Rep t Writing 2011
37/57
37
Appendix
z Lengthy material related to your report
z If you cite published work in the
appendix, it must be added to yourreference list
z
Include your raw data
7/29/2019 Lab Rep t Writing 2011
38/57
38
Preparing effective figures and
tables
z Readers often look at figures and
tables to see what the report is aboutz Each figure and table:
JMUST BE CAPABLE OF STANDING ONITS OWN WITHOUT REFERENCE TOTHE TEXT!!
z Decide if you want to present your datain a figure or a table
7/29/2019 Lab Rep t Writing 2011
39/57
39
Table size and formatz A table consists of a
JTitleJColumn headings
JRow or side headings
JExplanatory notes
z Decide if the data presented in the tablecould be better presented in a graph
z Keep the structure as simple as possible
7/29/2019 Lab Rep t Writing 2011
40/57
40
Tables
z Decide what tables you need
z Design separate tables for separate topics
z Do not use tables to show off how much
data you have collectedz Dont repeat data in tables if you are suing
the data in the text or in a figure
z NEVER INCLUDE A TABLE THAT IS NOT
REFERRED TO IN THE TEXT
7/29/2019 Lab Rep t Writing 2011
41/57
41
Example
Table 1 Diseases in three species of fish in lakes in North Wales
Disease Species Habitat
X A Lake 1
We can see that: species A in lake 1 was affected
by diseases X and Y, species B in lake 2 by disease
Y, and species C in lake 3 by diseases X and Z.
X C Lake 3Y A Lake 1Y B Lake 2Z C Lake 3
7/29/2019 Lab Rep t Writing 2011
42/57
42
Figures
z Decide what figures you need
z Figures are meant to demonstrate evidence vividly
z Springer-Verlag recommends to place figures at the top of the pagez Figures must be simple and clear
J Label axes simply and clearly
JScales should be appropriate, if two scales are present make insert
JMark scale calibrations clearlyJMake lines and curves clear and label and differentiate them clearly
JNumber and identify the figure in the text
NEVER INCLUDE A FIGURE THAT IS NOT
REFERRED TO IN THE TEXT
7/29/2019 Lab Rep t Writing 2011
43/57
43
Examplez Messy looking
z Key has double symbols
z Vertical lettering difficultto read
z Lettering in all capsproduces unrecognizable
abbreviationsz Lettering placed too far
below x-axis
z No units are given for x-axis
z Ticks inside axes can beconfused with data
z No legend
7/29/2019 Lab Rep t Writing 2011
44/57
44
Better example
7/29/2019 Lab Rep t Writing 2011
45/57
45
Another example
No data pointsNo error analysis
Units confusing
7/29/2019 Lab Rep t Writing 2011
46/57
46
Notes on languagez Make sentences more specific
JUsually found through editingJBe sure to match the amount of detail with
needs of audience
During the test the sample was cooled.During the test, the sample was placed in an ice
bath.
The information should be enough to repeat the
experiment
z Keep your sentences to 10-20 words
7/29/2019 Lab Rep t Writing 2011
47/57
47
Notes on languagez Use only the third person
Je.g. do not use We found or We measuredz Do not use acronyms without first defining
them
z Use SI unitsJkg, m, J, N etc.
z Write in the past tense
z Write in an active voice, rather than apassive one
JConveys more excitement and is more concise
7/29/2019 Lab Rep t Writing 2011
48/57
48
Passive vs. active verbs
z Use of passive verbs
JLongwinded
JDull
z Long sentences make reading difficultz Active verbs make your sentences
simpler, clearer, less awkward andmore concise
7/29/2019 Lab Rep t Writing 2011
49/57
49
Passive and active voiceThe experiment was conducted so that the relationship
between the two theories could be examined. First, thecultures were prepared and then were examined under the
microscope to see if any impurities could be found. Once
the purity of the samples could be established, they were
used in six independent tests. (51 words)
The experiment examined the relationship between the two
theories. First, microscopic examination for impuritiesisolated pure examples used in six independent tests. (22
words)
7/29/2019 Lab Rep t Writing 2011
50/57
50
Nominalizingz Avoid excessive nominalizing
JForming nouns from verbsWhen you make the noun acceleration from the verb
accelerate you are nominalizing
z Technical writing often contains a lot of these
nounsJMakes the document harder to read
z Look for ways to make the statement more directly
JRegeneration of the resin bed is achieved by a calciumchloride solution.
JA calcium chloride solution regenerates the resin bed.
7/29/2019 Lab Rep t Writing 2011
51/57
51
Stacked modifiersz Avoid stacked modifiers (noun stacks)
J Two or more nouns jammed together in aphrase - makes reading difficultThe underground plant effluent soil contamination
did not threaten the environment.
This underground soil contamination by the planteffluent did not threaten the environment.
z To unstack noun stacks, you spread the
information out into phrases and clausesand convert some of the nouns to verbs
7/29/2019 Lab Rep t Writing 2011
52/57
52
Dangling modifiersz Avoid dangling modifiers
JModifies a word not clearly stated in thesentenceHaving finished the lab experiment, the light was
turned offWho finished the lab experiment?
Having finished the lab experiment, the studentturned off the light
z Dangling modifiers leave unansweredquestions
Title Page Part of Overall Impression
7/29/2019 Lab Rep t Writing 2011
53/57
53
Abstract 5%
Table of Contents Part of Overall ImpressionList of Tables Part of Overall Impression
List of Figures Part of Overall Impression
Introduction 10%Theory 10%
Experimental Procedure 10%
Results 15%
Discussion 20%
Conclusions 10%
Error Analysis (can be part of Discussion) 10%
References Part of Overall ImpressionAppendices and Raw Data Part of Overall Impression
Overall Impression 5%
Presentation and clarity of Figures and Tables 5%
Total Points 100%
7/29/2019 Lab Rep t Writing 2011
54/57
54
Submitting the lab reportz The lab report is due one week after you
have finished the entire 3-week labassignment during your regular lab section
z Turn your lab report into your TA, instructors
or lab staffwithin 1/2 hourof the start ofthe labJLate labs will be graded with a significant point
reduction!z You MUST also submit an electronic version
of the report to laboratory staff
Turn your lab report into the TA of your
experiment at the latest at 3pm one daybefore ou start our new ex eriment
7/29/2019 Lab Rep t Writing 2011
55/57
55
Recommended textsz Writing for Engineers and Scientists
JAlley, Michael (1987). The Craft of Scientific Writing. Englewood Cliffs,
NJ: Prentice-Hall.J Paradis, J.G. and Zimmerman, M. (1997). The MIT Guide to Science andEngineering Communication. Cambridge, Mass.: MIT Press.
z Style Guides & Writers' References
JAlley, Michael (1999). The Craft of Editing: A guide for managers,
scientists and engineers. Englewood Cliffs, NJ: Prentice-Hall.JAlred, G., et al. (2000). The Handbook of Technical Writing. St. Martins
Press. [New edition to be published February 2003.]
J Hacker, D. (2000). A Pocket Style Manual. Bedford/St. Martins.
J Raimes, A. (2002). Keys for Writers: A brief handbook. Houghton Mifflin
Publishers.J Strunk and White (2000). The Elements of Style, fourth edition. Boston :
Allyn and Bacon.
z Writing for Research
J Locke, L., et al. (1998). Reading and Understanding Research. ThousandOaks, CA. Sage Publications.
Posted report writing handouts for
7/29/2019 Lab Rep t Writing 2011
56/57
56
Posted report writing handouts for
more informationz On the website
maecourses.ucsd.edu/labcourse you canfind:
JReport writing format and key elements of your
report and the grading sheetJDescriptions and worksheets can be found for:Introduction
Experimental Procedures
Results
Discussion
7/29/2019 Lab Rep t Writing 2011
57/57
57
Plagiarismz Plagiarism is defined as presenting
someone else's work, including the workof other students, as one's own.
z UCSD POLICY ON INTEGRITY OF
SCHOLARSHIP(http://www-senate.ucsd.edu/manual/appendices/app2.htm)J"No student shall plagiarize or copy the work of another
person and submit it as his or her own work"
J"The instructor shall determine the student's grade onthe assignment and in the course as a whole.""Any breach of academic honesty may be considered
grounds for failure in the course"
Top Related