Engineering Report Guide UFL
Engineering Report Guide UFL
University of Florida
by
Revision 8
PREFACE
These notes are intended to serve as a guide for writing engineering reports for the Unit Operations Laboratory
courses at the University of Florida.
Oscar D. Crisalle
Professor of Chemical Engineering
University of Florida, Gainesville
-i-
TABLE OF CONTENTS
PREFACE................................................................................................................................................................... i
REPORTS REQUIRED FOR EACH EXPERIMENT ....................................................................................... 1
PROPOSED REPORT FORMATS........................................................................................................................ 1
1.
2.
2.
3.
- ii -
Preliminary-Design Report
Final Report
The Preliminary-Design Report indicates what specific experiments are to be carried out and documents details of
the experimental strategy to be followed.
1.
PRELIMINARY-DESIGN REPORT
The Preliminary-Design Report documents your design of an appropriate experiment to achieve clearly
specified objectives. Typically this report is prepared before the first experiments are carried out and is based on
data available from the literature or from computer simulations.
Title page
Identify the experiment with a descriptive title. Include names of all participants, date
of submission, and dates when experiments were carried out. This page must also bear
the subtitle: "Preliminary-Design Report".
Table of Contents
Lists each major section and subsection and their page numbers.
Objectives
Indicate precisely the objectives of the experiment, i.e., identify the specific results
sought. Be succinct, clear, and unambiguous. Do not exceed one page.
Introduction
Indicate what is the overall plan of the experiment: what must be done and how, which
variables are manipulated and which are measured. Clearly indicate what the reader
should expect to find in each of the subsequent sections.
-1-
Theory
Describe the applicable equations and their assumptions.
assumptions are reasonable for this experiment. Do not derive any equations that can
be found in a standard textbook; simply state the equation with a reference to the
source. All symbols must be defined.
equations that are not relevant to the experiment. Do not include unnecessary symbols
or variables. Clearly indicate which equations, and in what order, are invoked to
design the experiment, interpret the results, and achieve the objectives. Refer the
reader to the Appendix for all auxiliary information.
Experimental Plan
Describe the runs you plan to make and how they relate to the objectives. Include a
table summarizing the conditions for each run. The table should list the proposed
setting for all the manipulated variables, but should not include any of the measured
variables.
Experimental Problems
Describe the problems you anticipate in getting the data you need and how you plan to
solve them. Discuss all issues that may be relevant to the outcome of the experiment,
such as inaccuracy of instrumentation, excessive times required to reach steady states,
etc.
Supporting Calculations
Using your best estimates of unknown parameters, you should establish, insofar as
possible, that the planned experimental conditions are reasonable. You must discuss
how your calculations support the experimental plan.
References
List all the literature sources that are cited in the report.
Appendix
Include information that, though relevant, is not of sufficient relevance to the
objectives of experiment to merit inclusion in the body of the report.
Include
Equipment diagrams
Include equipment and layout diagrams that may be essential for characterizing
the features of the experimental units.
-2-
2.
FINAL REPORT
The Final Report documents the conclusions obtained from analyzing the results of the experiment. This
report is prepared after all the experimental work is done, and it discusses the results in terms of the specific
objectives of the study. The major sections of the report are outlined below.
Title page
Identify the experiment with a descriptive title. Indicate names of all participants, date
of submission, and dates when experiments were conducted. This page must also bear
the subtitle: "Final Report".
Table of Contents
Include each major subsection and its page number.
Abstract
Summarize the important results. The abstract must be self-contained: do not refer to
figures and tables located in other sections of the report. Do not include tables, figures,
and equations, unless absolutely necessary.
Objectives
It is convenient to restate the objectives even if they had been already mentioned in the
Preliminary Design Report. The objectives serve as a guide to the results. Indicate
precisely the objectives of the experiment. Be succinct, clear, and unambiguous. Do
not exceed one page.
Results
Include all tables and graphs that document your final results.
information so that you can later refer to these figures in the Discussion section to
support your conclusions. If possible, present the results in the same order that you
listed the objectives. Do not discuss the significance of the results. Include only final
results that satisfy the objectives of the experiment; lengthier tables and intermediate
figures should be included in the Appendix. Introduce the reader to each figure and
table with a brief paragraph indicating what variables are plotted or tabulated. Each
figure and table must have a unique number and a title or caption.
Sample Calculations
Give one example of each calculation that leads to a result reported in the document.
Include one calculation for each figure or table reported in the Results section.
Introduce each calculation with a brief paragraph indicating to the reader which
-3-
Discussion
Discuss the significance of each result documented in the Results section; address each
table and figure in the order that they were presented. Use the available theory to
explain why the relevant variables behaved in the observed fashion.
References
List all the literature sources that are cited in the report.
Appendix
Include information that, though relevant, is not necessary to mention in the body of
the report to support the experimental design plan. Include additional appendices as
needed.
o
Calculation files
Computer printouts
-4-
1.
GENERAL GUIDELINES
1G
2G
Each figure must have a descriptive caption (and optionally a title). Each table must have a
caption.
4G
Each figure and table appearing in the report must be mentioned in an appropriate accompanying
paragraph in the text. Unreferenced ("floating") figures and tables are unacceptable.
5G
6G
Use different line types or plotting symbols to denote different curves in a figure.
Avoid using
8G
9G
10 G
11 G
12 G
13 G
In this course it is required that the present tense be used throughout the report whenever possible,
as if the actions and calculations of the experimentalists were taking place when the document is
being read. Avoid using past and future verb tenses; more specifically, avoid using "will" and
"was" whenever possible.
-5-
15 G
16 G
17 G
Avoid wordy sentences. Separate a long sentence into smaller logical sentences.
18 G
meaning.
For example, the following sentence is imprecise because, contrary to the intention of the writer, it
incorrectly states that "the equilibrium line is not physically possible":
The data are inconsistent because the operating line crosses the equilibrium line which is
physically impossible.
The intention of the author might better be stated through the alternative sentence:
Since it is physically impossible for the operating line and the equilibrium line to cross, it is
concluded that the data are inconsistent.
19 G
Whenever possible, it is good practice to avoid the repetitive use of the pronoun "we". Also avoid
using the forms "our" or "us." On the other hand, use "we" to claim personal responsibility for an
important decision made:
-6-
Handwritten corrections or special symbols can be included in the report provided that the
annotation is done neatly in ink.
Do not assume that the reader knows any details about the FORTRAN programs you use.
For example, it is not sufficient simply to state "The program EFFA is used for calculating
efficiencies". For completeness the authors must clearly indicate (1) the program's name, (2) the
programming language used, (3) what the program does (what theoretical equations or theories it
evaluates numerically), (4) what inputs are required, and (5) what outputs are produced.
Such
program descriptions must be complete but brief. It is usually reasonable to present the most
relevant features of the computer programs in the Theory section, and if appropriate, more detailed
information the Appendix. All the important equations solved by the program should be listed in
the Theory section.
22 G
Do not refer to an equation by their number before the equation has been introduced and
numbered. You can refer to equations by their numbers only in the paragraphs that follow the
appearance of the numbered equation.
For example, the following sentence is unacceptable because the author refers prematurely to
"Equation (1)" before that particular equation is actually presented and numbered:
The temperature difference T is used in Equation (1) to determine the heat flux
Q = m Cp T
(1)
In cases like the example above it is recommended to omit the premature reference to the equation
number. For example, an improved version of the sentence is:
The temperature difference T is used to determine the heat flux
Q = m Cp T
23 G
(1)
It is not necessary to precede every equation by a sentence that ends with a colon. In most cases
the equation should be presented as it if is part of the introductory sentence, without using any
punctuation marks (such as a colon or a period).
For example, the colon is not necessary at the end of the first sentence shown below:
The temperature difference T is used to determine the heat flux::
Q = m Cp T
where m is the mass and Cp is the specific heat of the object.
-7-
(1)
-8-
(1)
2.
1. P
PRELIMINARY-DESIGN REPORT
Title page
1.1 P
1.2 P
Identify all the authors and list them in alphabetical order (by last name).
1.3 P
Give a descriptive title to the report. Avoid uninformative titles, such as "Experiment No. 1". Use
content-rich titles such as "Determination of heat-transfer coefficients in a recovery boiler". On
the other hand, it is also important to avoid excessively long titles.
1.4 P
1.5 P
1.5 P
1.6 P
All authors must sign the report. The signatures lines may appear at the bottom of the cover page,
or on a separate sheet on a second page.
2. P
Table of Contents
2.1 P
3. P
Objectives
3.1 P
3.2 P
The Objectives section must be self-contained. Do not make references to figures, tables or
equations found elsewhere in the report.
3.4 P
Try to minimize or avoid altogether the use of mathematical symbols in the Objectives section.
Use symbols instead of the name of variables only when the name must be repeated several times.
3.5 P
The Objectives section should contain no undefined symbols (preferably, it must include no
symbols whatsoever).
-9-
If possible, avoid using figures, tables, or equations to state the experimental objectives.
3.7 P
If possible, avoid listing the objectives as a series of bullets. Use descriptive narrative in a
paragraph form instead.
4. P
Introduction
4.1 P
Indicate what activities are to be done in this experiment and how you propose to carry it out these
activities. Outline the general plan by indicating which variables are adjusted, which ones are kept
constant, etc. Do not give unnecessary details; simply share with the reader the approach you plan
to adopt for achieving the objectives.
4.2 P
4.3 P
4.4 P
Include only minimal equipment descriptions in the Introduction. Point out only equipment
details that are of particular relevance to the attainment of the experimental objectives. All other
details (such as complex diagrams, experimental set-up descriptions, etc.) should be relegated to
the Appendix. The authors can then easily refer the interested reader to the material in the
Appendix.
4.5 P
Do not include a discussion of why this experiment is important or relevant. You should assume
that you have been given the engineering task of carrying out the experiment by a supervisor who
already knows that this work is important.
4.6 P
Finalize this section by writing one paragraph that tells the reader about the contents of each
section that follows.
5. P
Theory
5.1 P
5.2 P
Define all variables and symbols. For example, do not assume that the symbol U universally
stands for "heat-transfer coefficient".
5.3 P
5.4 P
Do not include equations that are irrelevant to the experiment and its objectives.
5.5 P
Do not rederive equations available in standard references such as textbooks or other scientific
publications. Simply write the final equation and cite the source.
5.6 P
All equations transcribed from the literature (books, papers, etc.) should be appropriately
referenced.
5.7 P
5.8 P
Precede each equation with a brief introductory sentence to make the theory more accessible to the
reader.
For example:
The heat transfer coefficient, Uo, is given by the equation
- 10 -
Q
Aeff Tlm
(1)
where Q is the heat lost through the walls, Aeff is the effective area for heat transfer, and Tlm
is the log-mean temperature difference.
5.9 P
5.10 P
Indicate clearly which equations, and in what order, are invoked to design the experiment,
interpret the results, and achieve the objectives.
5.11 P
An effective strategy for organizing the Theory section is to first establish all the relevant
equations, and then follow up with a discussion of how each equation is used to obtain the
objectives of the experiment.
5.12 P
All equations and statements taken from the literature must be referenced in the body of the report.
For example, to indicate that an equation is taken from the textbook for this course, you could use
the following citation format:
Equation (3) is given in (McCabe et al., p. 445, 1993).
Note that (1) the reference is identified by enclosing it in parenthesis, (2) since the book
referenced has three or more authors the reference only shows the last name of the first author,
while co-authors are represented by the italicized Latin abbreviation et al. which means "and
others", (3) the abbreviation "p." precedes the number of the page where the equation appears in
the book, and finally, (4) the year of publication of the reference is indicated before the closing
parenthesis, preceded by a comma.
6. P
Experimental Plan
6.1 P
Use a table to describe the runs you plan to make. The table should include the proposed values
for the manipulated variables but must not include any entries for the dependent variables (data
you intend to gather).
The table should not include blank columns (i.e., empty columns), blank
rows, or blank cells intended to be filled up with data after the experimental data is gathered
because the tables included in this report should describe the experimental plan proposed and
hence should not be constructed as future data repositories.
6.2 P
Use succinct paragraphs to explain how the runs relate to the objectives of the experiment.
For example, if one of the objectives of the experiment is to determine the effect of pressure drop
on the of a heat-transfer coefficient, you may include the following statement:
Table 1 summarizes the runs planned to determine the dependence of the heat-transfer
coefficient on the pressure drop. Runs 1 through 4 are carried out at four different pressure
- 11 -
7. P
Experimental Problems
7.1 P
7.2 P
7.3 P
Establish whether the assumptions in the theory are met to a reasonable extent (say within a 3%
error, a typical level of confidence in engineering practice).
8. P
Supporting Calculations
8.1 P
You must discuss how the calculated values support the experimental plan; simply listing a series
of calculation results does not suffice. Be succinct and precise in your discussion. Use a brief
introductory paragraph for each calculation, clearly indicating to the reader what is the motive or
intention of the calculation.
8.2 P
Refer each supporting calculation to an equation or technique described in the Theory section.
8.3 P
Output from FORTRAN programs or other software such as MathCAD, Mathematica, MATLAB,
or various spreadsheet packages are not acceptable in "raw" form. The Supporting Calculations
Section should contain only calculations that support the experimental plan.
Additional
References
9.1 P
Include references to the texts, manuals, or scientific papers that serve as the source for the
equations appearing in the report.
For example, you should list as a reference the textbook for this course using the following
citation format:
McCabe, W. L., J. C. Smith, and P. Harriet, Unit Operations of Chemical Engineering, Fifth
Edition, McGraw-Hill, Inc., NY (1993).
Note that (1) the initials of the first author are listed after his last name while the initials of the
other authors appear before the last name, (2) the title of the book is written in italics
- 12 -
Other formats are also possible, but this one follows the
Each references listed in this section must have been cited in other sections of the report, and vice
versa. Exclude all references that are not cited in other sections.
10. P
Appendix
10.1 P
Label all subsections of the Appendix and give each subsection a descriptive title.
For example, the second subsection of the Appendix could be identified with the title: "Appendix
2. Equipment Diagram".
10.2 P
10.3 P
Each subsection must be self-contained. An introductory paragraph should be used to inform the
reader about the contents of each subsection.
11. P
12. P
Equipment diagrams
12.1 P
All drawings of equipment, experimental set-up, and various diagrams should be preceded with an
introductory paragraph.
- 13 -
3.
1. F
FINAL REPORT
Title page
1.1 F
1.2 F
Identify all the authors and list them in alphabetical order (by last name).
1.3 F
Give a descriptive title to the report. Avoid uninformative titles, such as "Experiment No. 1". Use
content-rich titles such as "Determination of heat-transfer coefficients in a recovery boiler". On
the other hand, you are also advised to avoid excessively long titles.
2. F
1.4 F
1.5 F
Table of Contents
2.1 F
3. F
Abstract
3.1 F
3.2 F
Do not include results that are irrelevant to the objectives of the experiment or to the purpose of
the Abstract.
3.3 F
The Abstract should be worded in highly precise language and must be brief. Avoid vague or
ambiguous sentences. Do not exceed one page.
3.4 F
3.5 F
Avoid whenever possible referring to specific experimental run numbers in the Abstract.
3.6 F
Try to minimize or avoid altogether the use of mathematical symbols in the Abstract. Use
symbols instead of the name of variables only when the name must be repeated several times.
3.7 F
The Abstract should contain no undefined symbols (preferably, it should include no symbols
whatsoever).
3.8 F
3.9 F
The Abstract should be self-contained. Do not make references to tables, figures, or equations
appearing elsewhere in the report.
3.10 F
Avoid using bullets in the Abstract unless strictly necessary. Ideally, the Abstract should be
written in narrative form rather than in outline form.
4. F
Objectives
4.1 F
4.3 F
Use precise and succinct statements. An example of a good statement of an objective is the
sentence: "The first objective is to determine the dependence of the heat-transfer coefficient on
the pressure drop across the evaporator". An example of a vague and imprecise statement that is
not acceptable is: "The objective is to characterize the heat-transfer coefficient of an evaporator".
This sentence is imprecise and vague because the word "characterize" may have multiple
interpretations.
4.4 F
The Objectives section must be self-contained. Do not make references to figures, tables or
equations found elsewhere in the report.
4.5 F
Try to minimize or avoid altogether the use of mathematical symbols in the Objectives section.
Use symbols instead of the name of variables only when the name must be repeated several times.
4.6 F
The Objectives section should contain no undefined symbols (preferably, it should include no
symbols whatsoever).
4.7 F
4.8 F
5. F
If possible, the objectives should not be expressed using figures, a tables, or equations.
Results
5.1 F
Introduce each figure with a brief paragraph to help the reader identify its contents. Do not
discuss the significance of the figures (this should be done in the Discussion section). The
description should clearly state what is plotted in each figure and give any additional information
that might be useful to the reader.
Introduce each table with a brief paragraph to help the reader identify the contents of the table. Do
not discuss the significance of the table (this should be done in the Discussion section). The
description should clearly state what is tabulated in each column, and include any additional
information that might be useful to the reader.
descriptive paragraph in the body of the report.
For example:
- 15 -
predicted values of the heat-transfer coefficient, and finally, the last column shows the
percentage error in the prediction.
5.3 F
Do not include tables with raw data. Such tables belong in the Appendix.
5.4 F
Do not include plots and tables of intermediate results since all intermediate results and
calculations should be relegated to the Appendix. Eliminate all table columns that do not contain
final results. If the results lead to a lengthy table, then consider reporting the results in a figure
and placing the long table in the Appendix.
5.5 F
Do not present the results by referring to specific "run numbers". Reference to specific runs may
useful in the Preliminary-Design report; however, it is non informative and most often irrelevant
to associate specific results with corresponding run numbers in the Results section of a Final
Report.
5.6 F
Do not report details of experimental conditions unless they are strictly necessary for the complete
and unambiguous statement of the results obtained.
5.7 F
Do not include program listings in the Results section. All listings should be included in the
Appendix.
6. F
Sample Calculations
6.1 F
The Sample Calculations should contain examples of each calculation done to obtain the graphs
and tables shown in the Results section. A comprehensive calculation file is unacceptable here (it
should be relegated to the Appendix). Each sample calculation is an illustration of how the author
proceeded to obtain relevant values presented in the Results section.
6.2 F
Each calculation (or series of calculations) must be linked to a specific data point reported in the
Results section.
6.3 F
The authors must clearly indicate in a brief introductory paragraph what each sample calculation
illustrates.
For example, the following paragraph can be used to identify the relevance of a sample
calculation:
The following calculation illustrates the generation of the heat-transfer coefficient value
plotted at a pressure of 17 mm Hg on the experimental curve of Figure 1.
Analogous paragraphs are necessary for the introduction of results reported in tables.
6.4 F
Each sample calculation must explicitly include the physical units of each variable.
6.5 F
When writing the report, it is good practice to first include all the detailed calculations in an
Appendix entitled Calculation File, and then transcribe to the Sample Calculations sections
selected calculations that can serve as clear examples of the results obtained. Add annotations and
explanatory remarks as needed.
- 16 -
Discussion
7.1 F
The Discussion section must indicate whether the experimental results can be explained using the
theory available. Plausible explanations should be given for the cases where the experiments and
the theory disagree,
7.2 F
The Discussion should preferably be organized following the same order of presentation of figures
and tables adopted in the Results section.
7.3 F
7.4 F
The authors should write the discussion paragraphs in such a way that the reader is clearly and
unambiguously informed about which specific table, figure, or other relevant result is being
discussed.
7.5 F
8. F
Make recommendations for further experimental work to resolve issues that may remain open
References
8.1 F
Include references to the texts, manuals, or scientific papers that serve as the source for the
equations appearing in the report.
For example, you may list as a reference the textbook for this course using the following format:
McCabe, W. L., J. C. Smith, and P. Harriet, Unit Operations of Chemical Engineering, Fifth
Edition, McGraw-Hill, Inc., NY (1993).
Note that (1) the initials of the first author are listed after his last name while the initials of the
other authors appear before the last name, (2) the title of the book is written in italics
(alternatively, book titles can be underlined), and (3) the year of publication of the book is listed at
the end enclosed in parenthesis.
Other formats are also possible, but this one follows the
All equations and statements taken from the literature must be referenced in the body of the report.
For example, to indicate that an equation is taken from the textbook for this course, you could use
the following format:
Equation (3) is given in (McCabe et al., p. 445, 1993).
Note that (1) the reference is identified by enclosing it in parenthesis, (2) since the book
referenced has three or more authors the reference only shows the last name of the first author,
while co-authors are represented by the italicized Latin abbreviation et al. which means "and
others", (3) the abbreviation "p." precedes the number of the page where the equation appears in
- 17 -
Each references listed in this section must have been cited in other sections of the report, and vice
versa. Exclude all references that are not cited in other sections.
9. F
Appendix
9.1 F
Label all subsections of the Appendix and give each subsection a descriptive title.
For example, the second subsection of the Appendix could be identified with the title: "Appendix
2. Equipment Diagram".
9.2 F
Each subsection of the Appendix must have been referred to in the body of the report.
9.3 F
Each subsection must be self-contained. An introductory paragraph should be used to inform the
reader of the contents of each subsection.
- 18 -