Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
THE PREPARATION OF
Prepared by
GEORGE TCHOBANOGLOUS and HAROLD LEVERENZ
Department of Civil and Environmental Engineering
University of California, Davis
Davis, CA
Copyright 2010
George Tchobanoglous and Harold Leverenz
Draft copy for personal use only
Version 01/27/2010
CONTENTS
Page
LIST of FIGURES . . . . . . . . . . . . . . . . . . . . . . v
LIST of TABLES . . . . . . . . . . . . . . . . . . . . . . . vi
FOREWORD . . . . . . . . . . . . . . . . . . . . . . . . vii
1. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . 1-1
Purpose . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Organization of Guidebook . . . . . . . . . . . . . . . . . 1-1
Acknowledgements . . . . . . . . . . . . . . . . . . . . 1-2
2. REPORT TYPES, ORGNIZATION, AND FORMATTING . . . . . 2-1
Types of Engineering Reports . . . . . . . . . . . . . . . . 2-1
General Organization of Formal Engineering Reports . . . . . . . 2-1
General Organization of Technical Papers . . . . . . . . . . . 2-4
Report Formatting . . . . . . . . . . . . . . . . . . . . 2-4
Mechanics of Report Preparation . . . . . . . . . . . . . . 2-7
3. PREPARATION OF TABLES . . . . . . . . . . . . . . . . 3-1
Development of Tables . . . . . . . . . . . . . . . . . . 3-1
Citation of Tables . . . . . . . . . . . . . . . . . . . . 3-2
Mechanics of Table Preparation . . . . . . . . . . . . . . . 3-2
4. PREPARATION OF FIGURES . . . . . . . . . . . . . . . 4-1
Development of Figures . . . . . . . . . . . . . . . . . . 4-1
Citation of Figures . . . . . . . . . . . . . . . . . . . . 4-2
Mechanics of Pictorial Illustrations . . . . . . . . . . . . . . 4-3
Mechanics of Data Plots . . . . . . . . . . . . . . . . . . 4-8
Mechanics of Photographs . . . . . . . . . . . . . . . . . 4-12
5. PREPARATION OF EQUATIONS . . . . . . . . . . . . . . 5-1
Mechanics of Writing Equations . . . . . . . . . . . . . . . 5-1
General Format for Equations . . . . . . . . . . . . . . . . 5-2
Placement of Equations in Text . . . . . . . . . . . . . . . 5-3
Equations in Examples or Sample Calculations . . . . . . . . . 5-3
6. CITATION OF REFERENCES . . . . . . . . . . . . . . . 6-1
Evaluation of Reference Sources . . . . . . . . . . . . . . 6-1
Citation Methods for Reference Sources . . . . . . . . . . . 6-2
Format Styles for Reference Lists . . . . . . . . . . . . . . 6-4
iii
7. SOME NOTES ON WRITING . . . . . . . . . . . . . . . . 7-1
8 WRITING THE REPORT . . . . . . . . . . . . . . . . . . 8-1
Preliminary Considerations . . . . . . . . . . . . . . . . . 8-2
Preparing an Outline . . . . . . . . . . . . . . . . . . . 8-3
Preparing Figures and Tables . . . . . . . . . . . . . . . . 8-3
Writing the First Draft . . . . . . . . . . . . . . . . . . . 8-3
Revising and Editing . . . . . . . . . . . . . . . . . . . 8-4
The Final Report . . . . . . . . . . . . . . . . . . . . . 8-5
9. EVALUATE YOUR WRITING . . . . . . . . . . . . . . . . 9-1
The Fog Index . . . . . . . . . . . . . . . . . . . . . . 9-1
Working Words and Glue Words . . . . . . . . . . . . . . . 9-2
10. PUNCTUATION AND WORD USAGE . . . . . . . . . . . . . 10-1
Punctuation . . . . . . . . . . . . . . . . . . . . . . . 10-1
Formation of Compound Words . . . . . . . . . . . . . . . 10-6
Abbreviations and Units . . . . . . . . . . . . . . . . . . 10-7
Using Words Correctly . . . . . . . . . . . . . . . . . . . 10-9
Words Commonly Misspelled . . . . . . . . . . . . . . . . 10-10
A Working Vocabulary . . . . . . . . . . . . . . . . . . . 10-11
11. TECHNICAL MEMORANDUMS . . . . . . . . . . . . . . . 11-1
Formatting . . . . . . . . . . . . . . . . . . . . . . . 11-1
Mechanics . . . . . . . . . . . . . . . . . . . . . . . 11-1
iv
FIGURES
9-1 Typical FWS constructed wetland: (a) definition sketch and (b) view of
FWS wetland at Gustine, CA
9-2 Typical SF constructed wetland: (a) definition sketch and (b) view of
FS wetland at Mesquite, NV
9-3 Typical floating plant aquatic treatment system: (a) definition sketch and
(b) view of water hyacinth system at San Diego, CA
9-4 View of Sacramento Regional CSD Demonstration Wetland
9-5 Typical constructed wetland for stormwater treatment
9-6 View of Arcata, CA FWS constructed wetland
v
TABLES
9-1 Representative applications of constructed wetlands and aquatic
treatment systems
9-2 Summary of principal removal and transformation mechanisms in
constructed wetlands for the constituents of concern in wastewater
9-3 Typical coefficients of variation for constructed wetlands subject to
different wastewater temperature variations
9-4 Typical characteristics of emergent plants used in constructed wetlands
9-5 Typical BOD and TSS removals observed in FWS constructed wetlands
9-6 Typical ammonia and nitrogen removals observed in FWS constructed
wetlands
vi
FOREWORD
3. Develop your writing skills. Practice writing within a prescribed time limit.
Writing that is labored will also appear the same to your audience and will
be cumbersome to read and understand.
4. Review, rewrite, and peer review your papers and reports. Writing is an
iterative process. Rewriting adds polish and elegance to a report or paper.
Ask a colleague to review what you have written and make constructive use
of the feedback. If anyone is willing to take the time to review what you
have written, their comments must be considered seriously. Peer review is
standard practice with most professional journals.
vii
1
INTRODUCTION
Even though a reader's interest is wholly in the subject matter his [sic] first impression
of a piece of writing is necessarily based on its general appearance. If the manuscript
is neat and well arranged, and if it has a clean-cut, finished look, any one who picks it
up is predisposed in favor of the writer and his work. The content, upon being closely
examined, may prove to be disappointing; but it will need to be strikingly poor in order
to [sic] wipe out entirely the favorable impression which was created at the start by its
good mechanical form. On the other hand, if a manuscript is illegible, untidy, scrappy,
or incomplete, the reader's reaction is certain to be unfavorable. The subject matter will
need to be exceptionally good in order to [sic] overcome the reader's adverse opinion.
1-1 PURPOSE
The purpose of this guidebook is to introduce and review the main elements involved
in the preparation of engineering reports including: the organization, structure, and
formatting of reports; the presentation of tables, figures, and equations; the citation
of references; and the writing reports and technical memorandums. Also included
are some tips on evaluating your writing for readability and wordiness and
mechanical elements and word usage. The preparation of oral presentations is also
addressed.
1-1
1 Introduction
1-4 ACKNOWLEDGMENTS
The completion of this writing guidebook would not have been possible without the
cooperation and assistance of numerous individuals - past and present. For all of
the students, engineers, writers, and editors who have helped and struggled with me
[senior author] in the past, my heartfelt thanks. The senior author is indebted to his
colleagues Jeannie Darby and Ed Schroeder, who encouraged and supported the
development of this guidebook and to the Department of Civil and Environmental
Engineering at University of California, Davis for allowing me to teach a course on
report writing.
1-2
2
REPORT TYPES,
ORGANIZATION, AND FORMATTING
Although each report is unique, all are much the same in adherence to some
recognized style and organization, the use of tables and figures for brevity and
clarity, references to the literature for background material and the support of
findings, the presentation of conclusions, and often the inclusion of data and other
reference materials in one or more appendixes for documentation. The purpose of
this section is to review: (1) the types of engineering reports used in practice, (2) the
general organization of engineering reports, (3) general organization of technical
papers, (4) the mechanics of report formatting, and (5) the mechanics report
preparation.
2-1
2 Report Types, Organization, and Formatting
Organization of Report
Engineering reports are organized into three major parts: (1) front matter, (2) report
body, and (3) end matter. The individual items that are typically included in each of
the three major parts of an engineering report are presented and described in Table
2-1. Because of its importance, an expanded discussion is included of what
constitutes an effective executive summary.
Table 2-1
Items included in the front matter, body, and end matter of formal engineering reports
Item Description
Front Matter Front matter is used to provide an overview of the information contained in the report,
including where the information is located. Depending on the scope of the report, not all of the
sections listed below may be necessary. The following items typically constitute the front matter of
most reports.
Front Cover The layout of the front cover may be defined by the agency for who the
report was prepared. Items on the front cover may include report title,
report date, report number, client or funding agency, and report authorship
Title Sheet Located inside front cover. Items included on the title sheet include full
report title; names of author(s), principal investigator(s), project committee
member(s), and/or company affiliation for the author(s); report date;
applicable copyright notice, and client or funding agency.
Letter of Transmittal Sometimes placed in front of the title sheet. Should be presented on
company letterhead and contains a letter submitting the report, references
the report authorization, and contains a general statement of the report
contents. The letter should be addressed to the client and signed by the
principal investigator or person in charge.
Executive Summary If used, sometimes included in front of report body. The executive summary
is a stand-alone summary of the project or study. Element of the executive
summary include a description of the task, what was done, key findings or
results, and future actions (see separate discussion in this section).
Contents Often listed as Table of Contents. Contains a listing of all major report
sections in the order presented in the report and the corresponding report
page number.
List of Figures All figures (illustrations, photographs, maps, data plots, etc.) contained in
the report should be numbered consecutively and listed along with their
corresponding page number on a separate report page titled 'Figures'. If
there are only a few figures, the list of figures may not be necessary.
List of Tables All tables contained in the report should be numbered consecutively along
with their corresponding page number on a separate sheet titled 'Tables'. If
there are only a few tables, the list of tables may not be necessary.
Abbreviations Sometimes combined with units. A listing of all abbreviations and symbols
used in the report presented with the corresponding phrase or symbol
description. May not be required if there are only limited abbreviations used
or if the intended audience is familiar with the abbreviations used in the
report.
Continued on following page
2-2
2 Report Types, Organization, and Formatting
Executive Summary Sometimes included with the front matter. See above.
1. Introduction General description of the study, including the purpose, objectives, and
scope, as needed to understand the detailed description of the study
presented subsequently in the report.
2. Project Description Presentation of information needed to explain the context of the report
and Background subject, including reference to previous related work
3. Review of Existing Description of the facility or system that is the focus of the study.
Facilities or Systems Explanation of the specific issues that have been encountered that
have brought about the study.
4. Review of alternatives Presentation of alternative facilities or systems that have been
identified and the development of a procedure to assess the
alternative scenarios.
5. Technical feasibility Assessment of the selected alternative scenarios based on the design
assessment specifications, suitability for the proposed application, or other criteria
as appropriate. The technical feasibility analysis results provide the
basis for selecting the alternative scenarios that should be subjected to
an economic and/or life cycle analysis.
6. Economic analysis An assessment of the expected economic impacts of the project,
including capital and operating expenses, and sources of revenue for
the project.
7. Life cycle analysis Evaluation of the overall environmental impact of the project or
proposed alternative(s), typically in terms of equivalent carbon dioxide
emissions. This type of analysis has become a standard requirement
for most engineering studies.
8. Comparison of Interpretation of the study findings, including important conclusions
alternatives and discussion of the implications of the technical, economic, and life
cycle analysis.
9. Summary and A brief restatement of all important findings identified in the study. It is
Conclusions good practice to review the project objectives to ensure that the report
is complete.
10. Recommendations Presentation of a proposed course of actions based on the conclusions
developed previously. This section may also include suggestions for
future studies that are needed.
Continued on following page
2-3
2 Report Types, Organization, and Formatting
Appendixes Used to present information relevant to the report but not appropriate for
inclusion in the report body, including basic or raw data, exhibits,
samples of data sheets, etc.
Blank Sheet Put before the report back cover.
Back Cover Should be of same paper stock as cover, text is sometimes added to the
outside, but may also be left blank.
2-4
2 Report Types, Organization, and Formatting
generalize the format used by most journals for technical articles as presented in
Table 2-2. Always refer to the journal specifications and requirements for the
submission of technical papers and articles.
Table 2-2
Items included in the front matter, body, and end matter of technical papers.
Item Description
Title and Authors The study title should clearly state the topic of the research.
The author(s), their affiliation(s), and contact information for
the corresponding author should be included under the title.
Abstract The abstract in a technical paper corresponds to the ES in the
technical report, as discussed above. The abstract, as with the
ES, is your chance to tell the story of your research study or
project; project details may be found in the paper.
Key Words Selected words, terms, and phrases used to identify the topics
or subjects considered in the paper.
1. Introduction General description of the study, including the purpose,
objectives, and scope, as needed to understand the detailed
description of the study presented subsequently in the report.
2. Background Presentation of information needed to explain the context of
the report subject. Generally, the background also contains a
summary, along with reference citations, obtained through an
extensive review of the literature.
3. Hypothesis A clear statement of the proposed explanation for an observed
phenomenon. The purpose of the study is to test the
hypothesis.
3. Experimental Facilities Description of the type of facility used for conduct of the study,
if applicable. Field studies may include a description of the
site, including coordinates and other relevant site information.
4. Methods and Procedures Explanation of the experimental protocols, experimental
design, analytical techniques, statistical evaluations, models or
other software platforms that were used, and other measures
relevant to the study. The methods section should contain
enough information such that another person could exactly
replicate the study and get the equivalent results.
5. Results Can also be titled 'Experimental Results'. Detailed
presentation of the study findings, such as measurements that
were made or output from modeling.
6. Discussion Interpretation of the study findings, including important
conclusions from the study, a description of how the results
support or disprove the hypothesis, discussion of how the
present results compare to previous results, analysis of the
implications of the results. In some cases, future studies that
are needed and/or recommendations that can be made as a
result of the study may also be presented.
Continued on following page
2-5
2 Report Types, Organization, and Formatting
Headings
Headings are used to introduce the general content of the presentation that follows.
To make maximum use of each heading some introductory text must follow. It is
poor form to have the text beginning with a second level heading.
Number of Second and Third Level Headings When second and third level
headings are used, a minimum of two second or third level headings must be used.
A single second or third level heading should not be used, as it is poor form.
Justification of Text
In engineering reports it is quite common for the text to be set with margins that are
justified (also referred to as flush-left, flush-right). Text that is not justified is referred
2-6
2 Report Types, Organization, and Formatting
2-7
2 Report Types, Organization, and Formatting
Placement of Headings
There are many acceptable arrangements for the placement of headings (e.g., flush-
left, indented, centered, etc.). Examples of heading placement are presented on
pages 2-9 and 2-10.
Use of Headers
In long reports or long chapters or sections, a header is used to identify the chapter
or section. In books, the left header is used commonly to identify the chapter and
the right header is used to identify the section within a chapter. The same format is
also used in long complex reports. Often the header is placed above a fine line as
used in this guidebook (see top of page). A header is not used on the opening page
of a chapter or section.
2. Two conventions are used for the body of the report. In the first method, the
body of the report is numbered consecutively starting with page 1. In the
second method, each chapter or section is number separately with the
chapter or section number placed in front of the page number. Either a dash
or period is used between the chapter or section number and the page
number (e.g., 2-1 or 2.1). The ES may be numbered as ES-1, etc., prior to
the first section.
2-8
2 Report Types, Organization, and Formatting
3. Two conventions are also used for the end matter of the report. In the first
method, where consecutive page numbering has been used for the body of
the report the consecutive numbering is continued throughout the end matter.
In the second method, each appendix is numbered separately (e.g., A-1, A.1,
etc.)
4. Page numbers are usually placed in the footer, either centered or justified
often below a fine ruled line as used in this guide (see bottom of page).
Although page numbers have been placed in the header or at the side of
each page, this practice is not common in engineering reports.
2-9
2 Report Types, Organization, and Formatting
In Outline Form
In Written Form
2
THE SETTING OF THE MASTER PLAN
Physical Characteristics
San Francisco is situated on the northern end of a narrow peninsula between the
Pacific Ocean on the west and the San Francisco Bay estuary on the north . .
Surrounding Waters
San Francisco Bay, bounds the eastern and northern margins of the city.
Approximately 40% of the land area of California drains through the bay.
Beneficial Uses. San Francisco Bay provides a wide variety of beneficial uses.
These include swimming, boating, fishing, duck hunting, tourism . .
Water Quality. Many San Francisco Bay species are contaminated and in decline.
Factors contributing to this situation may include increasing . .
Land Use
Of the total city land area, 82% is developed. Somewhat less than half of this
developed area is residential (Association of Bay Area Governments, 2004).
2-10
2 Report Types, Organization, and Formatting
In Outline Form
In Written Form
2
THE SETTING OF THE MASTER PLAN
2-11
2 Report Types, Organization, and Formatting
2
PAGE FORMATS FOR REPORTS
2-12
2 Report Types, Organization, and Formatting
Upper margin
formats
1 - 1.0 in Top of header (9 pt) is placed 0.5
2 - 1.0 in in below the top of the page. The
3 - 1.0 in header is placed on the right hand
4 - 1.0 in
side of the page in the single page
format. Two spaces are used
between the number and the title
of the chapter or section.
Intermediate pages
Four different formats are shown for use with 8.5 by 11 in paper.
2-13
3
PREPARATION OF TABLES
When developing and referring to a table in the text, the following points should be
considered.
1. Why is the table being presented?
2. Reasons for the design of the table.
3. What does the table contain?
4. Source of original data or information?
5. How have the data been manipulated?
6. Why are some data missing?
7. What exceptions are there to the normal meaning of rows and columns?
8. What is the accuracy of the data?
9. What is the statistical variation of the data?
10. Describe the rows and columns of the table.
11. How do related or comparable data in the table correlate among themselves?
12. How do the data correlate with other data in the same report?
13. How do the data correlate with data from other publications?
14. What is the meaning of the data?
15. What conclusions can be drawn from the data presented in the table?
3-1
3 Preparation of Tables
Tables must be keyed to the text at least once. The table should be placed
immediately after its first mention, either on the bottom half of the same page or on
the top of the next page. If tables are placed several pages after first being cited,
the reader will lose comprehension.
The mechanics of table development involve understanding the parts of the table
and the mechanics of formatting.
Parts of a Table
Tables are comprised typically of the following parts:
1. Table number and title
2. Boxhead (used to identify the entries in the vertical columns)
3. Stub (used to identify the horizontal entries in the table)
4. Boxhead for the stub
5. Field (the area of the table in which the data are presented)
The above parts of a table are identified in Table 1.
Table Formatting
The mechanics of table formatting involve the arrangement of the columns and rows,
and the spacing within the columns and rows as shown in Table 2. The proper
format for tables is illustrated in Tables 3 through 6. All of the tables shown are of
the open type in that they are not boxed in with borders on all sides. In presenting
data values in tables the units should be placed in a separate column or included in
boxhead title, as appropriate. The inclusion of a separate column for units is
illustrated in Table 3; units are included in the column headings in Table 4. A table
with multi-level or hierarchical entries is presented in Table 5. The presentation of
figures in a table is illustrated in Table 6. When footnotes are included with tables
they are usually lettered with a superscript and arranged left to right from top to
bottom. Specific journal conventions should be used for publications.
3-2
3 Preparation of Tables
1 205 5 0 760 30 92
2 205 5 15 650 25.5 90.5
3 205 5 30 530 21 88.5
4 205 5 40 460 18 87
5 410 10 0 760 30 92
6 410 10 15 650 25.5 90.5
7 410 10 30 530 21 88.5
8 410 10 40 460 18 87
9 820 20 0 760 30 92
10 820 20 15 650 25.5 90.5
11 820 20 30 530 21 88.5
12 820 20 40 460 18 87
13 1230 30 0 760 30 92
14 1230 30 15 650 25.5 90.5
15 1230 30 30 530 21 88.5
16 1230 30 40 460 18 87
3-3
3 Preparation of Tables
3 pt space
Presentation of Tables
Tables may be designed to occupy the full width of the typed page, but generally are
more pleasing in appearance when smaller than the full width of the page. Tables
are centered usually, but may be placed on the left margin. When tables are
presented in the landscape mode, in either a single page or back to back format, the
bottom of the table should face the right side of the page.
3-4
3 Preparation of Tables
3-5
3 Preparation of Tables
3-6
3 Preparation of Tables
3-7
4
PREPARATION OF FIGURES
The effective development and use of figures in technical reports is of critical
importance. In many cases, a quality figure can convey quickly a great deal of
information that would otherwise be laborious to describe only in text. The figures
used in technical reports are of three general types: (1) pictorial illustrations such as
process flow diagrams (schematics), organization charts, and work flow diagrams;
(2) plots of experimental, computational, and operation data; and (3) photographs
and renderings of equipment and facilities. The development of figures, citation of
figures, and mechanics involved in the development of figures are considered in the
following discussion. Separate sections are devoted to each type of figure for clarity.
The questions that must be asked for each type of figure are discussed below. If the
report is ever to be reproduced in black and white, the impact on color figures must
be considered. In general, it is a good policy to confirm that all figures will reproduce
correctly in black and white.
4-1
4 Preparation of Figures
4-2
4 Preparation of Figures
Figures must be keyed to the text at least once. The figure should be placed
immediately after its first mention, and depending on the size, either on the bottom
half of the same page, the top half of the next page, or on a full page following the
first mention of the figure.
Lettering
For most purposes, the type size used in illustrations should be 10 pt. In some
cases, a smaller type size may be used where the figure is larger and the type size
is therefore reduced to fit. San serif fonts, such as Helvetica or Ariel, should be used
for illustrations. When a type size of 10 pt is used for the regular text, superscripts
and subscripts should be 8 pt, and raised or lowered by 2 pt, respectively. Where a
type size other than 10 pt is used, the superscript and subscript should remain
proportional.
4-3
4 Preparation of Figures
descriptive text. The line should be a hairline, or 0.5 pt, as a heavier line will distract
from the diagram and may be confused for a line in the illustration. When possible,
supporting callout text should be set slightly away from the actual illustration to focus
the readers eye on the diagram itself. The callout line should approach the
supporting text in a balanced manner. Running the callout lines in parallel will result
in an organized look.
Arrows are never used to callout a feature or detail, and are only used to show the
direction of flow or movement. It is important to select an arrow shape and size that
is balanced and consistent with all figures in the report. An example arrowhead
detail including the proportions for arrowhead and the connecting line are shown on
Fig. 4-1.
Standard Details
Process flow diagrams typically include features such as pumps, flow meters,
gauges, and valves. It is recommended to use a standard set of details for these
features for purposes of consistency and effectiveness of conveying information to
the reader. A sample pump detail that is used in process flow diagrams is shown on
Fig. 4-2. Most agencies have a catalogue of standard details.
Figure 4-1
Dimensions of arrowhead used to represent flow direction or movement
Figure 4-2
Standard pump detail
4-4
4 Preparation of Figures
Software Recommendations
Illustrations can be prepared using any of the various commercially available
software packages, however, not all illustration software packages are equal. For
example, the drawing software that accompanies MS Word is not very sophisticated
and can only be used for preparing simple diagrams, unless significant time is
invested. The preferred software when high quality technical illustrations are to be
prepared is Adobe Illustrator. AutoCAD is useful for the preparation of precision to-
scale drawings, however, technical illustrations prepared using AutoCAD can be
difficult to import into a technical report due to inconsistencies with other illustrations.
In many cases, the illustrations placed in technical reports will not need to be drawn
to scale.
Sample Illustrations
A few technical illustrations are shown below to familiarize the reader with the some
of the techniques described in this section. Lines with arrows are used to represent
the UV light emitted during UV disinfection on Fig. 4-3. The plan view of an MBR
facility is presented on Fig. 4-4. As shown on Fig. 4-4, several of the callout lines
are drawn parallel, resulting in an organized look. Also shown on Fig. 4-4 are the
standard arrowhead and pump details. Using standard features helps the reader
focus on the substance of the figure instead of being distracted by non-uniformity.
An informational process flow diagram with inserts is shown on Fig. 4-5. Two
examples of 3-dimensional illustrations are presented on Figs. 4-6 and 4-7. An
integrated wastewater management scheme employing centralized, satellite, and
decentralized facilities is shown on Fig. 4-6. Figure 4-7 is a 3-dimensional depiction
of the 2-dimensional MBR shown on Fig. 4-4. Two process flow diagrams are shon
on Figs. 4-8 and 4-9.
4-5
4 Preparation of Figures
Figure 4-3
Particle interactions that affect the effectiveness of UV disinfection including microorganism shading;
light scattering, reflection, and refraction; and incomplete penetration
Figure 4-4
Plan view of membrane bioreactor with an anoxic section for nitrogen removal
4-6
4 Preparation of Figures
4-7
4 Preparation of Figures
Figure 4-6
Diagram of future hybrid wastewater management system incorporating both
decentralized, satellite, and centralized facilities.
Figure 4-7
Koch Puron submerged hollow fiber membrane bioreactor
4-8
4 Preparation of Figures
Figure 4-8
Proposed process flow diagram for the City of Davis Wastewater Treatment Plant.
Dashed lines indicate alternative flow pathways or intermittent flows.
4-9
4 Preparation of Figures
When a large data set is to be plotted, bar charts can be cumbersome. Line, scatter,
and bar charts can be used for plotting three-dimensional data when a z-axis is
included. Pie charts are used for comparing percentages of a whole, however,
because of their high space to information content ratio, pie charts have limited
application in technical reports. Statistical plots may include features such as error
bars, confidence intervals, and other information about the distribution. Statistics
textbooks or reference guides should be consulted when preparing statistical plots.
Probability distributions are another type of statistical plot used commonly when
working with environmental data sets. Information on construction and interpretation
of probability distributions can be found in Asano et al., 2007.
4-10
4 Preparation of Figures
technical reports are 3 in. by 3 in. and 2.75 in by 4 in. for the y- and x-axis lengths,
respectively. Line weights should be selected for a balanced look. Typical line
weights used for data plots are 1 pt for the border, 0.75 pt for tick marks, 0.5 for
internal gridlines. The size of the marker used for data points should be selected so
that they are not too small to be obscured by lines or curve fits, and not so large that
they overlap or obscure other information on the plot. For most purposes a 9 or 12
pt data marker is adequate. Data marker characters should be selected to ensure
that they will be unique even when reproduced in black and white. Lines connecting
data point markers and curve fits should be 0.75 to 1 pt.
Axis labels should be set slightly away from the axis values. As a starting point, both
axis labels and values should be 10 pt. Internal text can be smaller that the text
used for axis labels, usually 8 pt. If callout lines are used in the data plot, a line
weight of 0.5 pt should be used, with lines drawn parallel where feasible to give an
orderly appearance. When legends are used, they should be placed in one corner
of the plot window, if there is sufficient space.
Software Recommendations
Software for preparing data plots include: MS Excel, Kaliedagraph, and Deltagraph,
among others. In some cases, it may be easier to manipulate data in one program,
e.g., Excel, while Kaliedagraph is used for development of the final data plot. When
necessary, data plots can further be exported into illustration software if other
features are to be added.
Sample Plots
Several sample plots are shown below to demonstrate different techniques for
presenting data. A simple scatter plot with a linear curve fit is shown on Fig. 4-10.
Important features to note on Fig. 4-10 include the faded gridlines that do not
interfere with the presentation of the data, sufficient tick marks to permit the reader
to determine the value of individual data points, and text inserts to identify the data
sets instead of a legend.
4-11
4 Preparation of Figures
A hybrid line-bar plot is shown on Fig. 4-11. The hybrid plot is used to display
several different data sets simultaneously. The probability distribution shown on Fig.
4-12 is plotted over a set of typical values. Construction of Fig. 4-12 required
several steps, extraction of the original data set from an MS Excel database, plotting
the data set in Kaliedagraph, and importing the plot into Adobe Illustrator, where the
typical values were inserted into the background for reference. Another example of
a hybrid plot involving a process schematic, a 3-dimensional illustration, and a data
plot are shown on Fig. 4-13. Of necessity, the lettering size has been reduced to
incorporate the necessary descriptions of the process steps.
Selection of Photographs
Photographs should be selected based on their content and quality. Ideally, the
content of the photo should be limited to the topic under consideration. Photographs
taken haphazardly may contain items such as passers-by, tree branches, or other
matter that obscures the point of the image. Photographs that are blurred or have
exposure problems will be difficult to recover and should not be used in technical
reports.
4-12
4 Preparation of Figures
Figure 4-10
Typical dose response curves for UV disinfection developed from data obtained using a collimated
beam device for dispersed microorganisms (Cooper et al., 2000)
Figure 4-11
Curves of chlorine residual versus chlorine dosage for wastewater containing ammonia nitrogen
(Adapted from White, 1999)
4-13
4 Preparation of Figures
Figure 4-12
Comparison of New Haven WWTP 2007 effluent probability distribution for TSS with range of effluent
probability values reported for conventional activated sludge processes (Asano et al., 2007).
Figure 4-13
Schematic illustration of the application of biodosimetry as used to determine the performance of a
test or full scale UV reactor (Adapted in part from Crittenden et al., 2005)
4-14
4 Preparation of Figures
Manipulation of Photographs
The development of photographs for use in technical reports can involve a number
of operations, including cropping, adjusting the brightness/contrast, removing
distortions, rotating, and resizing. For guidance in performing these operations,
photo editing software and the associated manuals should be consulted.
Software Recommendations
There are numerous commercially available software bundles for photo editing
including products by Adobe and Corel. It is advised that, regardless of the software
selected for image editing, instructional books should be obtained and used to
ensure user proficiency.
Sample Photographs
Several sample images are shown below to demonstrate different approaches for
presenting photographic images in technical reports. Images of treatment processes
are shown on Fig. 4-14, while close-up detail photographs of a laboratory procedure
are shown on Fig. 4-15. A hybrid satellite photo with text callouts is shown on Fig. 4-
16. White lines have been added to the callout lines to them easier to follow.
4-15
4 Preparation of Figures
Geographic coordinates are given in the title for Fig. 4-17 to allow the reader to gain
additional insight on what is depicted in the photograph by locating the specific site
using software such as Google Earth.
(a)
(b)
4-16
4 Preparation of Figures
30 minutes
minutes
(a)
60 minutes
minutes
(b)
4-17
4 Preparation of Figures
Figure 4-17
Rio Hondo Spreading Grounds operated by the County Sanitation Districts of Los Angeles County.
These basins and the unlined portions of the rivers and creeks permit large volumes of reclaimed
water to percolate into the aquifer. (Coordinates: 33.993 N, 118.105 W, view at altitude 4 km.)
4-18
5
PREPARATION OF EQUATIONS
In reports and papers, equations are used to define the relationship between two
or more variables symbolically. The mechanics, format, and placement in text of
equations is considered in the following discussion.
The correct way to write the equation (with only one open slash) is:
V (3.00 m3 / s)
=
Q (0.100 m3 / s)
5-1
5 Preparation of Equations
(1)
(for n ≠ 1) (2)
(for n = 1) (3)
(4)
(5)
(6)
5-2
5 Preparation of Equations
(7)
With the first method, the quantity of sludge produced daily (and thus wasted
daily) can be estimated using Eq. (7-26) (Tchobanoglous et al., 2003):
(7-26)
where PX,VSS = net waste activated sludge produced each day, kg VSS/d
Yobs = observed yield, g VSS/g substrate removed
Q = influent flow, m3/d
So = influent substrate concentration, g/m3 (mg/L)
S = effluent substrate concentration, g/m3
Note: Equal signs are aligned
5-3
6
CITATION OF REFERENCES
In preparing reports and papers it is common to reference sources from the literature
for corroborating information and data to support or disprove a point. Whenever
mention is made of material derived from another source (e.g., concepts, data,
figures, etc.), the source of the material must be identified so that the reader knows
who to credit. Strategies for selecting reference sources, techniques used for proper
citation of references, and formatting styles for reference lists are discussed in this
section.
Research Articles
1. Is a meaningful, testable question presented in the introduction?
2. Is the study design appropriate for the research question?
3. Were adequate sampling techniques, controls, and procedures used to
ensure the validity of their results?
4. Are the data and results presented in a clear and unambiguous manner
5. Are the conclusions logical and supported by the results?
6. Were alternative explanations or conclusions considered?
6-1
6 Citation of References
Review Articles
1. Is the focus of the review on a specific research question or issue?
2. What types and kinds of sources are used in preparing the review? How up-
to-date are these sources? Are the sources cited the original, or are they
secondary citations.
3. Is it clear how each of the sources cited in the review was used to contribute
to an understanding of the research question or issue?
4. Are the major sources discussed in the review evaluated critically or are they
merely summarized?
6-2
6 Citation of References
Parenthetical Citation
In the parenthetical method of citation, either the author and date or a number
are included in the text (typically within parentheses) to identify material taken
from another source. It is assumed that the reference listing contains the
following: (1) full authorship, (2) the full title of the work, and (3) the
publication information. When the cited work is by two authors, both are
included in the citation. When three or more authors are involved, the et al.
format is adopted [e.g., (White et al., 1996)].
Citation By Author And Date In the author and date method of citation, the
name(s) and date are included within parentheses.
One author: (Jones, 2000)
Two authors: (Jones and Jones, 2000)
Three or more authors: (Jones et al., 2000)
Sort by year when there are multiple citations:
(Author, 2000; Author, 2001; Author, 2002)
(White, 1996; White and White, 1997; White et al., 1998)
(Burton et al., 1995; Crites and Tchobanoglous, 1998; Asano, 2000)
If the author is mentioned by name in the text, then only the date is included:
Jones et al., (2000) reported on the...
… used in Standard Methods (2003).
Note: Do not use Italic for “et al.”
Two types of numbering schemes are used for the reference list: citations
presented in sequence and citations presented in alphabetical sequence. In
the first case, citation numbers are presented in sequence [e.g., (1), (2), (3), .
6-3
6 Citation of References
The difficulty with the use of the numbering scheme for references is that if a
reference is forgotten, then all of the reference numbers in the text must be
changed to accommodate the added reference. By comparison in the
author/date citation format discussed above, an additional reference can be
accommodated easily. If numbered references are used, it is suggested that
you write the manuscript using the author/date citation format. When the
manuscript is complete, number the references and then insert the
appropriate numbers in the text in place of the author/date citation.
Footnote Citation
In the footnote citation style superscripted numbers are used to identify
material taken from another source. The source of the material
corresponding to a given number in the text is identified at the bottom of the
page. If the number of citations is lengthy, the footnotes may run to the
second page. This citation style is seldom used in engineering reports.
6-4
6 Citation of References
General guidelines for the format style used for journal citations are as follows:
First author: Last Name, First and Middle initials.
Other authors: First and Middle initials, Last Name.
For more than one author, insert “and” before the last author.
No period or comma between the last author and (year).
Journal article title is in quotation marks, comma inside of the quotation mark.
Use Title Case, except for “a” “of” “the” “from” etc.
Journal name or standard abbreviation is in Italic, followed by a comma (see
list of standardized journal abbreviations given in Table 6-1).
Journal volume = number in bold followed by a comma.
Journal issue number = number not bold followed by a comma.
Journal pages = number-number (e.g., 872-895) followed by period.
Use a period in the very end.
Examples of the formatting of reference lists are presented below for citations to
journal articles, books, works with editors, government agencies and professional
organizations, conference proceedings, and websites.
Articles in journals
Angelakis, A.N., M.H.F. Marecos do Monte, L. Bontoux, and T. Asano (1999) “The
Status of Wastewater Reuse Practice in the Mediterranean Basin: Need for
Guidelines,” Water Res., 33, 10, 2201-2217.
Benjamin, M.M., G.V. Korshin, and C.W. Li (1997) "The Decrease of UV Absorbance
as an Indicator of Tox Formation," Water Res., 31, 6, 946-949.
(Note: Alternate placement of initials)
Benjamin, M.M., Korshin, G.V., and Li, C.W. (1997) "The Decrease of UV
Absorbance as an Indicator of Tox Formation," Water Res., 31, 6, 946-949.
Edwards, M., and T. Meyer (1996) "Lead versus Alkalinity and pH," J. AWWA, 88, 3,
81-90.
Tchobanoglous, G., F. Maitski, K. Thomson, and T.H. Chadwick (1989) "Evolution
and Performance of City of San Diego Pilot Scal;e Aquatic Wastewater
Treatment System Using Water Hyacinths," J. WPCF, 61, 11/12, 1245-1257.
(or vol. 61, no.11/12, pp 1245-1257)
6-5
6 Citation of References
Table 6-1
Summary of journal abbreviations used commonly in environmental engineering
Journal title Abbreviation
Agricultural Water Management Agr. Water Mgnt.
American Institute of Chemical Engineers Journal AIChE J.
Applied Environmental Biology Appl. Environ. Microbiol.
American Journal of Public Health Am. J. Public Health
Biosystems Engineering Biosyst. Eng.
Chemical Engineering Science Chem. Eng. Sci.
Corrosion Science Corros. Sci.
Environmental Progress Environ. Prog.
Environmental Science & Technology Environ. Sci. Technol.
Industrial and Engineering Chemistry Research Ind. Eng. Chem. Res.
Irrigation Science Irrig. Sci.
Journal American Chemical Society J. Am. Chem. Soc.
Journal Environmental Engineering Division, J. Environ. Eng. Div. ASCE
American Society of Civil Engineering
Journal of Membrane Science J. Membr. Sci.
Journal American Water Works Association J. AWWA
Journal Water Environment Control Federation J. WPCF
Journal Water Environment Federation J. WEF
Ozone Science & Engineering Ozone Sci. Eng.
Proceedings of Water Environment Federation Proceedings of WEFTEC 2007
Technical Exhibition and Conference 2007
Transactions American Society of Agricultural Trans. ASAE
Engineers
Water Research Water Res.
Water Environment Research Water Environ. Res.
Water Science and Technology Water Sci. Technol.
Books
Asano, T. (ed.) (1985) Artificial Recharge of Groundwater, Butterworth
Publishers, Boston, MA.
Asano, T., F.L. Burton, H. Leverenz, R. Tsuchihashi, and G. Tchobanoglous
(2007) Water Reuse: Issues, Technologies, and Applications, McGraw-
Hill, New York.
Baird, R.B., and R.K. Smith (2002) Third Century of Biochemical Oxygen
Demand, Water Environment Federation, Alexandria, VA.
6-6
6 Citation of References
Crittenden, J.C., R.R. Trussell, D.W. Hand, K.J. Howe, and G. Tchobanoglous
(2005) Water Treatment: Principles and Design, 2nd ed., John Wiley & Sons,
Inc, New York.
Oliver, B.G., and E.G. Cosgrove (1975) "The Disinfection of Sewage Treatment
Plant Effluents Using Ultraviolet Light," J. Chem. Eng., (Canadian), 53, 4, 170-
174.
Tchobanoglous, G., F.L. Burton, and H.D. Stensel (2003) Wastewater
Engineering: Treatment and Reuse, 4th ed., Metcalf and Eddy, Inc.,
McGraw-Hill Book Company, New York. (Note: , NY. omitted)
6-7
6 Citation of References
6-8
6 Citation of References
WHO (2000) Global Water Supply and Sanitation Assessment 2000 Report,
WHO/UNICEF Joint Monitoring Programme for Water Supply and Sanitation,
World Health Organization, Geneva, Switzerland.
WPCF (1989) Water Reuse: Manual of Practice, SM-3, Water Pollution Control
Federation, Alexandria, VA.
WRI (2000) World Resources 2000-2001: The Frayinig Web of Life, World
Resources Institute, Washington DC.
Conference proceedings
Richards, D., R.W. Crites, T. Asano, and G. Tchobanoglous (1993) “A Systematic
Approach to Estimating Wastewater Reclamation Costs in California,” 235-245,
in Proceedings of WEFTEC 2006, Water Environment Federation, Anaheim,
CA.
Websites
Caltech Library Services (2010) "Journal Title Abbreviations," California Institute of
Technology, accessed 10 Janurary 2010,
<http://http://library.caltech.edu/reference/abbreviations/>.
CDC (2006) “Legionellosis: Legionnaires’ Disease (LD) and Pontiac Fever,” in
Disease Listing, Division of Bacterial and Mycotic Diseases, Center for Disease
Control and Prevention, accessed 2 October 2009, <http://www.cdc.gov/>.
U.S. Census Bureau (2003) "Population briefing national population estimates for
July, 2001," United States Census Bureau, accessed 8 May 2004,
<http://www.census.gov/>.
Yardley, J. (2005) "Rural Water Worries Persist After Chinese Chemical Spill," The
New York Times, accessed 16 February 2008,
<http://www.nytimes.com/2005/11/27/international/asia/27china.html?pagewant
ed=print>.
6-9
6 Citation of References
Citation Software
Many people are now using integrated citation software, such as EndNote to compile
and format reference lists. The advantage of citation software is that reference lists
for technical articles are reports can be generated instantly from citation libraries.
Citation libraries can be assembled manually by entering data, or downloaded from
online research databases. Inserting the citation into the document automatically
adds the full citation to the reference list, which is updated automatically as changes
are made. While citation software can be used to generate a reference list rapidly,
extra care must be taken to ensure correct formatting and to check for redundancy
errors. Writers are encouraged to first become familiar with reference citation styles
before becoming dependent on the output of citation software.
6-10
7
SOME NOTES ON WRITING
When writing reports, it common to fall into bad habits with respect to word
usage, grammar, and the use of unnecessary expressions. Another common
problem is allowing inanimate objects to take active roles in the presentation
(e.g., "Figure 1 directs the reader . . ."). The purpose of this section is to identify
some of the more common writing problems and to offer alternative approaches
to avoid poor usage. The question of whether text should be flush-right justified
is considered in Chap. 2. The errors in the following listing should be identified
using the search function present in all word processing programs and weeded
out systematically.
1. In general, reports should be written in third person. The terms “I,” “we,” or
“our” should never appear anywhere in the text. If these terms are found,
the sentence should be rewritten to eliminate them. Search for “I,” “we,” or
“our” and edit them out.
7-1
7 Some Notes on Writing
6. The phrase “in order to” should never be used. “In order to” should be
replaced with the word “to.”
7-2
7 Some Notes on Writing
14. If a foreign term is used, it is "de rigor" to use it correctly. (replace "de rigor"
with "de rigueur")
15. Avoid the use of mixed metaphors in engineering writing. For example:
19. Order of fences (parentheses, brackets, and ellipses) in text and equations:
parentheses ( ) first, followed by brackets [ ], followed by ellipses { }.
7-3
7 Some Notes on Writing
{⎡⎣( )⎤⎦}
At the present time, the California Department of Health requires a Ct value
[the product of the residual chlorine concentration, C (mg/L) and contact
time, t (min)], of 450 mg-min/L.
Decimal values in the text should be reported with numerals and therefore
cannot be used at the beginning of a sentence.
7-4
7 Some Notes on Writing
Examples: “see Sec. 6-2” or “see Secs. 7-5 and 7-6”. First word of
sentence: “Section 6-2” or “Sections 6-2 and 6-3”
c. Guidelines for equations
Equation is "Eq." or "Eqs." The word "Equation" or "Equations" is
spelled out if either is the first word in the sentence. No parentheses
"()" around the equation numbers that are referred to in the text. But
parentheses should appear around the equation number on the
equation line. Examples: “… as defined previously in Eq. 5-1” or “…
defined in Eqs. 5-1 and 5-2”. First word of sentence: “Equation 5-1” or
“Equations 5-1 and 5-2”.
7-5
7 Some Notes on Writing
7-6
8
WRITING THE REPORT
In preparing engineering articles for publication, project reports, or books, the
most important consideration is the audience. The style of an engineering report
for a technical review panel will be different than that for a city council. If there
are multiple audiences, the writing should be geared to the level of understanding
of the least knowledgeable audience. As it works out, if your mother understands
your report, chances are good the engineers will also understand it, although the
reverse may not be true.
Engineers often ask about style. The answer is not to worry about style, but to
write as clearly as you know how. Write as though you are explaining the
subject to a friend. If you continue to strive to write as clearly as you know how,
your style will evolve naturally.
Effective report writing involves hard work, a willingness to review and rewrite as
many times as necessary, and the motivation and enthusiasm to persist. The
best way to become an effective writer is to write, write, and continue to write
each chance you get. Some suggestions that will help one become a better
technical writer are (adapted in part from M&E, 1965):
3. Develop your writing skills. Practice writing within a prescribe time limit.
Writing that is labored will also appear the same to your audience and will
be cumbersome to read and understand.
4. Ask colleagues to review what you have written and make constructive
use of the feedback you receive. If anyone is willing to take the time to
8-1
8 Writing the Report
The general steps involved in preparing engineering reports are discussed in the
remained of this chapter.
In the above listing, the question "who is the audience?" is of critical importance
as it will affect the style and form of the memo, article, or report. It is not a
question of whether to be technical or not technical, it is a question of visualizing
or imagining your reader and directing your writing to them. In all cases, the
writing should be geared for the reader with the lowest level of understanding,
especially if you are conveying new concepts and ideas.
8-2
8 Writing the Report
8-3
8 Writing the Report
and apologetic. It is also important not to take for granted anything the reader
should know. Thus, it is necessary to present any information that would be
needed, so the reader does not have to guess what the author had in mind.
The body of the report should be reviewed to make sure that the statements that
belong in other parts of the report are moved or eliminated. It should be noted
that statements and ideas are not repeated in the body of the report. An
exception is their repetition in the conclusions and or the abstract (Sanks, 1979).
8-4
8 Writing the Report
to focus the report to meet your purpose and the intended audience. Asking a
colleague to review all or a portion of the manuscript will also be helpful. Before
beginning the revising and editing process it is best to put the report away for a
day of two, before you start the process. In revising and editing the report it is
useful to scan each page and ask yourself does the material presented help to
further the purpose and objectives of the report, should some material be moved
to another section for a more logical flow, and should some material be discarded
for clarity and brevity.
8-5
9
EVALUATE YOUR WRITING
Once a report has been prepared in draft form, and the process of rewriting has
begun, it is also useful to evaluate your writing for readability, conciseness, and
excessive use of non-essential words. Over the years, a number of different
methods have been devised to assess a written work. For the purpose of this
guidebook, two methods are used to evaluate written material. The first method,
known as the "Gunning Fog Index" (or "Fog Index") has been developed to assess
the readability of a written text (Gunning, 1968). The second method, which deals
with "working words" and "glue words" was developed to improve the conciseness
and precision of written text and to reduce the use of non-essential words (Wydick,
2005).
The value of the fog index can vary from about 5 to more the 20. For example, a
value of 12 would correspond to the reading level of a high school senior. Technical
writing with a fog index greater than 12 will be difficult for most people to read.
9-1
9 Evaluate Your Writing
9-2
9 Evaluate Your Writing
9-3
10
PUNCTUATION AND WORD USAGE
This chapter deals with the important mechanical elements that are a
fundamental part of report preparation. The subjects considered in this section
include: (1) punctuation, (2) formation of compound words, (3) abbreviations and
units, (4) using words correctly, (5) words commonly misspelled, and (6) a
working vocabulary. It is not the intent here to replace the many books that have
been written and continue to be written on these subjects, but to present a brief
review of these elements for quick reference. For a more in depth study of these
elements and other issues related to writing, The Economist Style Guide (The
Economist, 2005), Plain English for Lawyers (Wydick, 2005), and the Handbook
of Technical Writing (Alred et al., 2006) are recommended.
10-1 PUNCTUATION
Apostrophe
The apostrophe is used to:
1. Form the possessive of all nouns.
Singular Plural
Normal Possessive Normal Possessive
Man man’s men men’s
Woman woman’s women women’s
individual individual’s individuals individuals’
children children’s doctors doctors’
10-1
10 Punctuation and Word Usage
Brackets
The bracket is used to:
1. Enclose comments, alterations, or corrections in quoted material.
“The subject matter will need to be exceptionally good in order to [sic] overcome
the reader's adverse opinion.”
In the above sentence, the expression "sic" italicized (Latin meaning “thus”),
enclosed in brackets, is inserted in the quoted material to highlight what the
authors believe is an error in grammar (the use of the term "in order to" instead of
the word "to").
“He [the superintendent] was preoccupied with the failure of the pumps.”
The words "the superintendent," enclosed in brackets, were added by the
authors for clarity.
2. Enclose reference citation numbers instead of parentheses.
It has been observed that bacterial populations in natural systems can acclimate to colder
temperatures and maintain their mass in spite of slower activity rates [24].
Colon
The colon is used to:
1. Introduce an enumeration or listing.
Key elements of the TRR concept include: (1) production of water suitable for potable use
from wastewater, (2) assessment of the relative health risk of the potable water produced
versus the existing potable supply, (3) assessment of an innovative and alternative
aquatic plant based secondary wastewater treatment system . . . .
The material to be presented is organized into sections dealing with: (1) types and
application of wetland and aquatic systems, (2) treatment kinetics in constructed
wetlands and aquatic systems, (3) free water surface constructed wetlands, (4)
subsurface flow constructed wetlands . . . .
10-2
10 Punctuation and Word Usage
"Even though a reader's interest is wholly in the subject matter his first
impression of a piece of writing is necessarily based on its general
appearance. If. . . . ."
3. Separate the hour and minute and the hour, minute, and second
9:27 a.m., 10:15:23 p.m.
Comma
The comma is used to:
1. Separate independent clauses in a compound sentence.
If numbered references are used, it is suggested that the manuscript be written using the
author/date citation format.
6. Set off a date, geographical expression, proper names, and a title after a
proper name
After November 25, 1996, the new routing program should be used.
Dash
The dash is used to:
1. Set off parenthetical comments and statements
Nitrite nitrogen⎯determined colorimetrically⎯is relatively unstable and is oxidized easily
to the nitrate form.
10-3
10 Punctuation and Word Usage
Note: Although commas and parentheses can be used for the same purpose, dashes
are more emphatic.
Ellipsis
The ellipsis is used to note a break in continuity to:
1. Indicate that words have been omitted from the end of a sentence
The material to be presented is organized into sections dealing with: (1) types and
application of wetland and aquatic systems, (2) treatment kinetics in constructed
wetlands and aquatic systems, (3) free water surface constructed wetlands, (4)
subsurface flow constructed wetlands. . . .
Note: Four spaced periods are used when material is omitted at the end of a sentence
2. Indicate that words have been omitted for the middle of a sentence
“The subject matter will need to be exceptionally good . . . to overcome the reader's
adverse opinion.”
Note: Three spaced periods are used to indicate words omitted within a quoted
sentence:
Exclamation Mark
The exclamation mark is used to:
1. After an exclamatory phrase, clause, or sentence
The activated sludge process is a mess!
No, the pumps failed!
Hyphen
The hyphen is used to:
1. Join certain compound words (e.g., compound adjectives-see Section 7-2)
The six-inch (6-in.) diameter pipe had failed.
A long-needed overhaul was necessary
10-4
10 Punctuation and Word Usage
Parentheses
Parentheses are used to:
1. Enclose numbers and letters in lists.
The material to be presented is organized into sections dealing with: (1) types and
application of wetland and aquatic systems, (2) treatment kinetics in constructed
wetlands and aquatic systems, (3) free water surface constructed wetlands, (4)
subsurface flow constructed wetlands, . . . .
2. Enclose reference citations author and date or number within the text.
It has been observed that bacterial populations in natural systems can acclimate to colder
temperatures and maintain their mass in spite of slower activity rates (Vela, 1974).
It has been observed that bacterial populations in natural systems can acclimate to colder
temperatures and maintain their mass in spite of slower activity rates (24).
Period
The period is used:
1. At the end of a sentence.
The project report is complete.
What is done is done.
Question Mark
The question mark is used:
1. At the end of a direct question.
Is Eq.12-3 correct?
10-5
10 Punctuation and Word Usage
Quotation Marks
Quotation marks are used in engineering writing to:
1. Set off short quotes
In his 1927 text, English Applied In Technical Writing, C. W. Park noted that: “Even
though a reader's interest is wholly in the subject matter his first impression of a piece of
writing is necessarily based on its general appearance.”
Semicolon
The semicolon is used to:
1. Set off independent clauses in a compound sentence
The work effort was planned for Monday; however, the contractor was busy on another
project.
2. Set off long or subdivided units in a series or when one or more of the
items in series contains commas.
Some of the reasons for the observed differences are as follows: (1) many organic
substances which are difficult to oxidized biologically, such as lignin, can be oxidized
chemically; (2) inorganic substances that are oxidized by the dichromate increase the
apparent organic content of the sample; (3) certain organic substances may be toxic to
the microorganisms used in the BOD test; and (4) high COD values may occur because
of the presence of interfering substances.
10-6
10 Punctuation and Word Usage
Compound words are formed by the union of two or more words to represent a
single concept, typically used as an adjective. The principal compound words
used in engineering reports are compound nouns and adjectives.
Compound Adjectives
The examples given below are chosen to illustrate the principal ways in which compound
adjectives are formed (Park, 1927).
10-7
10 Punctuation and Word Usage
5 Phrase compounds
make-or-break (analysis)
state-of-the-art (review)
filter-to-waste (percent)
area-to-volume (ratio)
Abbreviations of names and terms, geographic names, Latin words, and units are
used routinely in engineering reports and papers to make them more readable by
avoiding the repetition of long phrases. Common abbreviations are considered in
this section.
10-8
10 Punctuation and Word Usage
Geographic Names
The abbreviations used by the U.S. Postal Service for states are given below.
State Abbrev. State Abbrev.
Alabama AL Idaho ID
Alaska AK Illinois IL
Arizona AZ Indiana IN
Arkansas AR Iowa IA
California CA Kansas KS
Colorado CO Kentucky KY
Connecticut CT Louisiana LA
Delaware DE Maine ME
Florida FL Maryland MD
Georgia GA Massachusetts MA
Hawaii HI Michigan MI
Minnesota MN Oregon OR
Mississippi MS Pennsylvania PA
Missouri MO Rhode Island RI
Montana MT South Carolina SC
Nebraska NE South Dakota SD
Nevada NV Tennessee TN
New Hampshire NH Texas TX
New Jersey NJ Utah UT
New Mexico NM Vermont VT
New York NY Virginia VA
North Carolina NC Washington WA
North Dakota ND West Virginia WV
Ohio OH Wisconsin WI
Oklahoma OK Wyoming WY
Latin Abbreviations
Latin abbreviations often used in engineering reports include:
ad lib., ad libitum (at will)
c., ca., circa (about, around)
e.g., exempli gratia (for example)
et al., et alii (and the others)
etc., et cetera (and other things; and so on)
et seq., and the following
i.e., id est (that is)
N.B., Nota Bene (note well)
op opus (work of music, art)
[sic] Bracketed and set in italics. The term is inserted in quoted material
to indicate that the writer being quoted is responsible for the
grammatical error.
v., vs., versus (against, in the direction of)
viz., videlicet (namely)
10-9
10 Punctuation and Word Usage
Units
Each engineering discipline has its own set of units and corresponding
abbreviations. The units and abbreviations used most commonly in the field of
environmental engineering are given in Appendix A-3 in both in SI and US
customary units. It is accepted practice when writing an engineering report not to
put periods after most measurement abbreviations (e.g., ft, min, s, and yd). The
abbreviated form of inches is typically written with a period (in.) to differentiate it
from the word "in."
10-10
10 Punctuation and Word Usage
Although misspelled words are often unavoidable, even with the advent of spell
checkers embedded with standard writing programs, every effort should be made
to learn the correct spelling and usage of words. The following is a listing of
words that are commonly misspelled (adapted from Park, 1927).
10-11
10 Punctuation and Word Usage
10-12
10 Punctuation and Word Usage
10-13
11
TECHNICAL MEMORANDUMS
The use of technical memorandums has become increasing popular in the
engineering community. Technical memorandums are used to describe the
progress on a segment of a large job as well as to describe the assessment
of new equipment or site visits to visit existing facilities. On some large
planning projects technical memorandums are designed to become individual
chapters, sections, or appendixes.
11-1 FORMATTING
A variety of formats are used for technical memorandums. Typical formats for
the reporting of engineering findings and visits to new facilities are presented
on the following two pages.
11-2 MECHANICS
Margins: Top = 1 in, bottom =1 in, left hand side = 1.25 in, and right hand side = 1.00
in or left hand side = 1.00 in and right hand side = 100 in.
11-1
11 Technical Memorandums
PROCESS DESCRIPTION
PROCESS APPLICATION
REFERENCES
See suggested citation format in Sec. 6.
Margins: Top = 1 in., bottom =1 in., left hand side = 1.25 in., and right hand side =
1.0 in. or left hand side = 1.00 in. and right hand side = 1.0 in.
11-2
11 Technical Memorandums
2. Site Visit
PROCESS DESCRIPTION
Brief description of facility including dimensions, throughput tonnage, capital
and operating costs.
REFERENCES
See suggested citation format.
APPENDIXES
Margins: Top = 1 in., bottom =1 in., left hand side = 1.25 in., and right hand side =
1.0 in. or left hand side = 1.00 in. and right hand side = 1.0 in.
11-3
12
ORAL PRESENTATIONS
Civil and environmental engineers are responsible for the technical aspects of a
community infrastructure comprising the basic installations and facilities on which
the growth and well-being of a community depends. To be effective in meeting a
community's needs, engineers must be able to communicate in a variety of
mediums including written, oral, and visual. Further, the ability to communicate
effectively will play an important role career advancement and professional
recognition. Some suggestions for improving the text of oral presentations are
presented in this section. Improvements on delivery involve practice, practice,
and more practice. The most important piece of advice about oral presentations
is to avoid reading your presentation material verbatim-it’s the kiss of death.
Your presentation materials should reflect the main ideas and add clarity to what
you are saying verbally.
12-1
12 Oral Presentations
12-3 FORMATTING
As noted above, the presentation materials must convey the main ideas and
reinforce the spoken word. The principal elements of the presentation materials
are:
Ideas, concepts, and themes
Lists of items
Illustrations
Tables-general information and data
Graphs-one and two dimensional
Figures-line drawings, pictorial graphics
Figures-photographs
Equations
With the advent of modern presentation packages, such as PowerPoint, the
formatting of presentations has become much simpler. In fact, most agencies
have their own style for general layout of PowerPoint slides, which typically
includes the name and logo of the organization or the agency.
Length of Presentation
As a general rule, one minute should be allowed per slide. Thus, for a thirty-
minute presentation which includes a ten minute question and answer period the
number of slide should be about 20, with 22 as a maximum for the twenty minute
presentation period. If you find that you have 30 or more slides, it is clear that
you have not prepared a thoughtful presentation, but have merely gathered
12-2
12 Oral Presentations
together stuff, which is an injustice to you and your audience. Take the time to
edit and to cut, cut, and cut. The amount of information per slide is considered
in the discussion on mechanics.
12-4 MECHANICS
The mechanics of PowerPoint presentations involve the placement of the pricipal
elements in a logical and manner that is easy to follow.
Examples
Examples of unacceptable and acceptable slides are presented below.
12-3
12 Oral Presentations
Revised - 25 words
12-4
12 Oral Presentations
12-5
12 Oral Presentations
12-6
13
REFERENCES
Two sets of references are included in the following listing: those cited in the
guidebook and other useful references.
13-1
13 References
Vinci, V. (1975) "Ten Report Writing Pitfalls: How to Avoid Them," Chem. Eng., 81,
26, 4548.
Wydick, R.C. (2005) Plain English for Lawyers, 5th ed., Carolina Academic Press,
Durham, NC.
Ebbitt, W.R., and D.R. Ebbitt (1982) Index To English, 7th ed., Scott, Foresman and
Company, Glenview, IL.
Guth, H.P. (1977) Concise English Handbook, 4th ed, Wadsworth Publishing
Company, Inc., Belmont, CA.
Houp, K.W., and T.E. Pearsall (1980) Reporting Technical Information, 4th ed.,
Collier Macmillan Publishers, Encino, CA.
Karls, J.B., and R. Szymanski (1975) The Writers Handbook, Laidlaw Brothers
Publishers: A division of Doubleday & Company, Inc., River Forest, IL.
Monroe, J., C. Meredith, and K. Fisher (1977) The Science of Scientific Writing,
Kendall/Hunt Publishing company, Dubuque, IA.
Park, C. W. (1927) English Applied In Technical Writing, F. S. Crofts & Co., New
York.
Rosen, L.J., and L. Behrens (1997) The Allyn & Bacon Handbook, 3rd ed., Allyn &
Bacon, Boston, MA.
Scott, J.H. (1928) Engineering English, John Wiley & Sons, Inc., New York.
Shaw, H. (1993) Punctuate It Right, 2nd ed., HarperPerennial: A Division of
HarperCollins Publishers, New York.
Strunk, W., Jr., and E.B. White (1979) The Elements Of Style, 3rd ed., Macmillan
Publishing Co., Inc., New York.
Trelease, S.F. (1958) How To Write Scientific And Technical Papers, The MIT
Press, Cambridge, MA.
Turabian, K.L. (1967) A Manual For Writers Of Term Papers, Theses, and
Dissertations, 3rd ed., The University of Chicago Press, Chicago, IL.
13-2
14
CONVERSION FACTORS,
ABBREVIATIONS, AND PHYSICAL CONSTANTS
A-1 Unit Conversion Factors, SI to U.S. Customary and U.S. Customary to SI
Acceleration
meters per second m/s2 3.2808 0.3048 ft/s2 feet per second
squared squared
meters per second m/s2 39.3701 0.0254 in/.s2 inches per second
squared squared
Area
hectare (10,000 m2) ha 2.4711 0.4047 ac acre
square centimeter cm2 0.1550 6.4516 In.2 square inch
square kilometer km2 0.3861 2.5900 mi2 square mile
square kilometer km2 247.1054 4.047 x 10-2 ac acre
square meter m2 10.7639 9.2903 x 10-2 ft2 square foot
square meter m2 1.1960 0.8361 yd2 square yard
Energy
kilojoule kJ 0.9478 1.0551 Btu British thermal unit
joule J 2.7778 x 10-7 3.6 x 106 kW•h kilowatt-hour
joule J 0.7376 1.356 ft • lbf foot-pound (force)
joule J 1.0000 1.0000 W•s watt-second
joule J 0.2388 4.1876 cal calorie
kilojoule kJ 2.7778 x 10-4 3600 kW•h kilowatt-hour
kilojoule kJ 0.2778 3.600 W•h watt-hour
megajoule MJ 0.3725 2.6845 hp•h horsepower-hour
Force
newton N 0.2248 4.4482 lbf pound force
Flowrate
cubic meters per day m3/d 264.1720 3.785 x 10-3 gal/d gallons per day
cubic meters per day m3/d 2.6417 x 10-4 3.7854 x 103 Mgal/d million gallons per day
cubic meters per m3/s 35.3147 2.8317 x 10-2 ft3/s cubic feet per second
second
cubic meters per m3/s 22.8245 4.3813 x 10-2 Mgal/d million gallons per day
second
cubic meters per m3/s 15850.3 6.3090 x 10-5 gal/min gallons per minute
second
liters per second L/s 22,824.5 4.3813 x 10-2 gal/d gallons per day
liters per second L/s 2.2825 x 10-2 43.8126 Mgal/d million gallons per day
liters per second L/s 15.8508 6.3090 x 10-2 gal/min gallons per minute
Continued on following page
A-1-1
Table A-1 Continued from previous page
Length
centimeter cm 0.3937 2.540 in. inch
kilometer km 0.6214 1.6093 mi mile
meter m 39.3701 2.54 x 10-2 in. inch
meter m 3.2808 0.3048 ft foot
meter m 1.0936 0.9144 yd yard
millimeter mm 0.03937 25.4 In. inch
Mass
gram g 0.0353 28.3495 oz ounce
gram g 0.0022 4.5359 x 102 lb pound
kilogram kg 2.2046 0.45359 lb pound
megagram (103 kg) Mg 1.1023 0.9072 ton ton (short: 2000 lb)
megagram (103 kg) Mg 0.9842 1.0160 ton ton (long: 2240)
Power
kilowatt kW 0.9478 1.0551 Btu/s British thermal units
per second
kilowatt kW 1.3410 0.7457 hp horsepower
watt W 0.7376 1.3558 ft-lbf / s foot-pounds (force)
per second
Pressure (force/area)
Pascal (newtons per Pa (N/m2) 1.4504 x 10-4 6.8948 x 103 lbf / in.2 pounds (force) per
square meter) square inch
Pascal (newtons per Pa (N/m2) 2.0885 x 10-2 47.8803 lbf / ft2 pounds (force) per
square meter) square foot
Pascal (newtons per Pa (N/m2) 2.9613 x 10-4 3.3768 x 103 in. Hg inches of mercury
square meter) (60°F)
Pascal (newtons per Pa (N/m2) 4.0187 x 10-3 2.4884 x 102 in. H2O inches of water (60°F)
square meter)
kilopascal kPa 0.1450 6.8948 lb/in.2 pounds (force) per
(kilonewtons per (kN/m2) square inch
square meter)
kilopascal kPa 0.0099 1.0133 x 102 atm atmosphere
(kilonewtons per (kN/m2) (standard)
square meter)
Temperature
degree Celsius °C 1.8 (°C) + 32 0.555(°F – 32) °F degree Fahrenheit
(centigrade)
degree Kelvin K 1.8 (K) – 459.67 0.555(°F + 459.67) °F degree Fahrenheit
Continued on following page
A-1-2
Table A-1 Continued from previous page
Velocity
kilometers per km/s 2.2369 0.44704 mi/h miles per hour
second
meters per second m/s 3.2808 0.3048 ft/s feet per second
Volume
cubic centimeter cm3 0.0610 16.3781 in3 cubic inch
cubic meter m3 35.3147 2.8317 x 10-2 in3 cubic foot
cubic meter m3 1.3079 0.7646 yd3 cubic yard
cubic meter m3 264.1720 3.7854 x 10-3 gal gallon
cubic meter m3 8.1071 x 10-4 1.2335 x 103 ac•ft acre • foot
liter L 0.2642 3.7854 gal gallon
liter L 0.0353 28.3168 ft3 cubic foot
liter L 33.8150 2.9573 x 10-2 oz ounce (U.S. fluid)
Source: Tchobanoglous et al. (2003)
A-1-3
A-2
CONVERSION FACTORS FOR COMMONLY USED
WASTEWATER TREATMENT PLANT DESIGN
PARAMETERS
ha 2.4711 0.4047 ac
kg 2.2046 0.4536 lb
m 3.2808 0.3048 ft
A-2-1
Appendix A-2 Continued from previous page
To convert, multiply in direction shown by arrows
SI units U.S. units
A-2-2
A-3
ABBREVIATIONS FOR UNITS
SI Units
centimeter cm kilojoules per kilogram kJ/kg
cubic meter m3 kilojoules per kilowatt-hour kJ/kW
cubic meter m3 kilometer km
cubic meters per second m3/s kilometers per hour km/h
degree Celsius °C kilometers per liter km/L
gram g kilowatt kW
grams per square meter g/m2 liter L
hectare ha liters per second L/s
joules per second per square meter J/s•m2 megajoule MJ
Kelvin K meter m
kilogram kg meters per second m/s
kilograms per capita per day kg/capita•d milligram mg
kilograms per cubic meter kg/m3 milligrams per liter mg/L
kilograms per hectare kg/ha Newton N
kilonewtons per square meter kN/m2 Newtons per square meter N/m2
kilosecond ks square kilometer km2
kilojoule kJ square meter m2
kilojoules per cubic meter kJ/m3
U.S. Customary Units
acre ac kilowatt kW
British thermaL unit Btu kilowatt -hour kWh
British thermal units per cubic foot Btu/ft3 pound (force) lbf
British thermal units per hour per Btu/hft pound (mass) lbm
British thermal units per kilowatt-hour Btu/kWh pounds per acre lb/acre
British thermal units per pound Btu/lb pounds per acre lb/acre
British thermal units per ton Btu/ton pounds per capita per day lb/capita • d
degree Celsius °C pounds per cubic foot lb/ft3
cubic foot ft3 pounds per cubic yard lb/yd3
cubic feet per minute ft3/min million gallons per day Mgal/d
cubic feet per second ft3/s miles mi
cubic yard yd3 miles per hour mi/h
day d miles per gallon mi/gal
degree Fahrenheit °F parts per million ppm
foot ft ounce oz
feet per minute ft/min pounds per square foot lb/ft2
feet per second ft/s pounds per square in lb/in2
gallon gal square foot ft2
gallons per minute gal/min square mile mi2
grain gr square yard yd2
horsepower hp ton ton
horsepower-hour hp-h watt-hour W-h
hour hr
yard yd
inch in.
A-3-1
A-4
PHYSICAL CONSTANTS
A-4-1