report writing guidelines - Illinois Center for Transportation

advertisement
Guidelines for Illinois Center for
Transportation (ICT) Reports
(updated 7-2-15)
Reports should fulfill project objectives set forth in the contract, show adequate documentation, and be
presented clearly. To assist PIs in preparing ICT reports, specific instructions are summarized below.
Complying with these formatting guidelines will minimize publication delays. All communications will be
with the PI or a designated contact.
Review Process, Criteria, and Submission
The following are the report review and publication phases. Please allow three months from the time
the report is submitted for the preliminary edit until it is ready for publication.

PRELIMINARY EDIT PHASE (Month One): The PI submits the complete report in MSWord
format to the ICT Editor. The PI should follow the ICT report formatting guidelines on the next
few pages. Reports not properly formatted will be returned to the PI for reformatting and
resubmission. The following documents are available for your use:
o
o
o
Instructions & Samples for ICT Reports (with Cover Page Template and Technical
Documentation Page)
Blank Word Template for ICT Reports
Acknowledgment & Disclaimer
The ICT Editor will perform a comprehensive technical edit of the report and return it to the PI
for review and revision. The PI reviews the ICT technical edits, accepts/rejects changes,
addresses all comments, and forwards the edited report to the project’s TRP Chair for review.

PI/TRP EDIT PHASE (Month Two): The TRP reviews and provides comments to the PI.
The PI incorporates the comments and returns the final version to the ICT Editor for
final editing.

FINAL EDIT PHASE (Month Three): When the report is approved by the TRP Chair, the PI
forwards the final report and the TRP Final Review/Approval Sign-Off Sheet for ICT Reports to
the ICT Editor for final editorial review. Reports submitted without the TRP approval form
will not be accepted. The form may be downloaded from the ICT website: TRP Final
Review/Approval Sign-Off Sheet (Word) or TRP Final Review/Approval Sign-Off Sheet (PDF)

PUBLISHING PHASE: The ICT Editor assigns an ICT report number, publishes the report on
the ICT website and Transportation Research Board databases, and prints hard copies and
CDs for distribution.
Report Submission
To submit reports for editorial review, contact:
Peggy Currid
ICT Technical Editor
currid@illinois.edu
1
Manuscript Specifications
Clearances and Copyrighted Materials
It is the authors’ collective responsibility to obtain all copyright permissions before submitting the
manuscript for TRP review.
Manuscript Organization
Submit the manuscript in a single electronic file organized in the following sequence. Start each section
on a new page. (See the following pages of these guidelines for additional details about report
organization.)
Cover Page
Technical Documentation Page
Front Matter
Acknowledgment, Disclaimer, Manufacturers’ Names
Executive Summary
Table of Contents [optional: List of Acronyms, List of Figures, List of Tables]
Body of Report
Back Matter
References
Appendices (if applicable)
Manuscript Page Setup
The manuscript should be formatted as follows:
 Length: The maximum length for reports is 75 pages (not including appendices). Any
exceptions should be approved by ICT/IDOT prior to submission.
 Margins: Use mirrored margins, with 1-inch top and bottom margins and .75 inside and outside
margins. To access the customized margin setup in Word 2007/2010, click on the Page Layout
tab, then select Margins, then Custom Margins. Type in the margin widths as shown below. Be
sure to select “Mirror margins” from the drop-down list in the center of the box.
2
 Font (typeface): Arial, 11 point.
 Text: Single-space between lines. One space between sentences.
 Justification: Left
 Paragraph Indent: 0.5 inch
 Numbering: Center page numbers at bottom of the page; use Arabic numbers starting with the
body of the report.
 Paragraphs: Indent first line of all paragraphs 0.5 inch; do not use an extra line space between
paragraphs; do not indent or center heads or subheads. 0-point spacing above and below
headings.
 Subheads: All subheads should be flush with the left margin, with one line space above.
 Citations in text: Al-Qadi 2006 (for one author); Al-Qadi and Janajreh 2006 (for two authors);
Al-Qadi et al. 2006 (for more than two authors; “et al.” is not italicized).
 Footnotes: Do not use footnotes in the text. Incorporate the information into the text or delete
the notes.
 Abbreviations, Acronyms, and Symbols: Abbreviations, acronyms, and symbols must be
fully defined at first use in the report; the definition should be given first, followed by the
abbreviated term in parentheses.
 Measurements: Measurements should be provided in U.S. customary units. Equivalent SI
(metric) measurements may be placed after the U.S. measurements in parentheses.
3
SECTIONS OF THE REPORT
Front Matter
ACKNOWLEDGMENT, DISCLAIMER, MANUFACTURERS’ NAMES
All publications for ICT projects should include the following acknowledgment and disclaimer, which you
can copy here and paste into your report:
This publication is based on the results of ICT-RXX [project number], Project Title here.
ICT-RXX [project number] was conducted in cooperation with the Illinois Center for
Transportation; the Illinois Department of Transportation, Division of Highways; and the
U.S. Department of Transportation, Federal Highway Administration.
Members of the Technical Review panel were the following:
[insert list of all TRP members and their affiliations, past and present, beginning with the
chair]
All publications giving the results of any investigation should contain the following disclaimer statement,
which you can copy here and paste into your report:
The contents of this report reflect the view of the author(s), who is (are) responsible for
the facts and the accuracy of the data presented herein. The contents do not
necessarily reflect the official views or policies of the Illinois Center for Transportation,
the Illinois Department of Transportation, or the Federal Highway Administration. This
report does not constitute a standard, specification, or regulation.
If any trademark or manufacturers’ names appear in the report, add the following statement to the end
of the disclaimer, which you can copy here and paste into your report:
Trademark or manufacturers’ names appear in this report only because they are
considered essential to the object of this document and do not constitute an
endorsement of product by the Federal Highway Administration, the Illinois Department
of Transportation, or the Illinois Center for Transportation.
4
EXECUTIVE SUMMARY
The executive summary must be no longer than three pages. It should present the study’s primary
objectives and scope or the reasons for writing the report; the techniques or approaches should be
described only to the extent necessary for comprehension; and findings and conclusions should be
presented concisely and informatively. The executive summary should not contain unfamiliar terms that
are not defined, undefined acronyms, reference citations, or displayed equations or lists.
When writing the executive summary, please use past tense verbs (see page 6 of this document for
additional details and sample.)
A Word About Writing
All ICT project reports must be written in good scientific English. Poor
sentence structure and grammar lead to delays in ICT’s technical
editing process, the TRP’s review, and final publication. Reports
containing excessive errors in grammar, syntax, spelling, and
punctuation will be returned to the Principal Investigator for
improvement.
The Principal Investigator is responsible for ensuring that the report
conforms to standards of good writing. Therefore, if someone else
writes a report (such as a co-author), the PI should review the report
before submitting it to ICT for editing.
5
CONTENTS
Chapter 1: Chapter Title.............................................................................................. #
Chapter 2: Chapter Title.............................................................................................. #
(etc.)
References ................................................................................................................. #
Appendix A (if used) ............................................................................................... A-1
Appendix B (if used) ............................................................................................... B-1
(etc.)
6
Body of Report
This is the report proper, where a researcher introduces the research, documents what has been done,
and makes conclusions and recommendations for future research. Please adhere to the following
guidelines regarding verb tenses:
EXECUTIVE SUMMARY
Use past tense. Example:
This study evaluated interface bonding between two HMAs. The main objective
of this study was to evaluate the performance of various tack coats and
determine optimum residual application rates.
INTRODUCTION
Introductions often include background information about generally accepted facts or universal
statements. These use present tense. Example:
The high cost to repair a large number of deteriorated bridge decks dictates an
optimum protection strategy. Protective overlays prevent the penetration of
chloride ions.
In most other cases, use past tense in the introduction Example:
To better quantify costs associated with initial construction and regular
maintenance, a life cycle cost analysis was completed for a 20-year period.
The design process presented within this report was used to determine the
initial pavement design and to calculate initial construction costs.
LITERATURE REVIEW
Use past tense. Example:
In a 1994 study, O’Brien found that the fiber deck overlay performed favorably.
METHODOLOGY (METHODS AND MATERIALS)
Use past tense. Example:
This study used specimens with diameters of 3.97 in (100 mm) and heights of
3.70 to 3.86 in (94 to 98 mm). A normal pressure of 1 psi (0.0069 MPa) was
applied to ensure minimum confinement of the specimen.
RESULTS
Use past tense. Example:
The air content, slump, and unit weight were all relatively variable, and the air
content varied by as much as 5% between two batches of the same mix. The
compressive strength appeared to be directly related to the FRAP content and
air content.
DISCUSSION/CONCLUSION
Verb tense varies depending on context. Examples:
 The study found variation in air content, slump, and unit weight. [past tense]
 Further studies on this subject are necessary. [present tense]
 Implementation of these recommendations will reduce costs. [future tense]
 Additional research should be conducted. [future perfect tense]
7
Please use the following formatting styles when preparing your report. ICT recommends using
its report template (http://ict.illinois.edu/research/ict_report_template.docx), which includes the
correct formatting styles.
CHAPTER 1
TITLE OF CHAPTER (14 pt Arial bold, all caps, flush left)
1. x FIRST-LEVEL HEAD (11 pt Arial bold, all caps, flush left)
1.x.x Second-Level Head (11 pt Arial bold, initial caps for each word, flush left)
1.x.x.x. Third-Level Head (11 pt Arial italics, initial cap for each word, flush left)
1.x.x.x.x. Fourth-level head (11 pt Arial underline, initial cap for first word only, flush left)
All figures and tables should be included as close as possible to their callout in the text. Figure captions
and table titles must be used consistently in the text. All reports will be printed in black and white; but
PDF reports may have colored figures/tables.
Example of figure caption: 11 pt Arial, centered, sentence case (begins with a capital letter, ends with
period], regular (not bold):
Figure 1. Critical pavement responses collected during trafficking (a) at the bottom
of the HMA layer, and (b) vertical displacement at the top of the subgrade.
Example of table caption: 11 pt Arial, centered, initial capital letter for each noun and verb, no period,
regular (not bold):
Table 1. Properties of Geogrid Product Used in the Full-Scale Test Sections
8
Back Matter
REFERENCES
In the reference list, list all references in alphabetical order. Below are examples of references and their
style (11 pt Arial for all):
Book
Findley W.N., J.S. Lai, and K. Onaran. 1976. Creep and Relaxation of Nonlinear Viscoelastic Materials.
New York: Dover Publications. 364 pp.
Book chapter
Lauer, K.R. 1991. “Magnetic/Electrical Methods,” pp. 203-226. In Handbook on Nondestructive Testing
of Concrete. V.M. Malhotra and N.J. Carino, Eds. Boca Raton, FL: CRC Press.
Doctoral (PhD) dissertation
Sussmann, T.R., 1999 (May). Application of Ground Penetrating Radar to Railway Track Substructure
Maintenance Management. PhD dissertation, University of Massachusetts, Amherst, MA. 230 pp.
Periodical
Yoo, J.P., I.L. Al-Qadi, M.A. Elseifi, and I. Janajreh. 2006. “Flexible Pavement Responses to Different
Loading Amplitudes Considering Layer Interface Conditions and Lateral Shear Forces.”
International Journal of Pavement Engineering 7(1):73-86.
Proceedings
Al-Qadi, I.L., and M. Elseifi. 2002. “Analytical Modeling and Field Performance Testing of
Geocomposite Membrane in Flexible Pavement Systems,” pp. 907-912. In Proceedings of the 7th
International Conference on Geosynthetics, P. Delmas and P.G. Grous, Eds. Nice, France,
September 22-27, 2002.
Reports
Al-Qadi, I.L., S. Lahouar, A. Loulizi, T.E. Freeman, and K.G. McGhee. 2005 (Jan.). GPR Calibration at
the Virginia Smart Road and Signal Analysis to Improve Prediction of Flexible Pavement Layer
Thicknesses. Final Contract Report No. FHWA/VTRC 05-CR7. Virginia Transportation Research
Council. Charlottesville: Virginia Department of Transportation. 65 pp.
Website
Nemmers, C. “Transportation Asset Management,” Public Roads Magazine, July 1997,
www.tfhrc.gov/pubrds/july97/tam.htm, accessed January 13, 2002.
APPENDICES (IF ANY)
Appendix number and title should be the same style as used for chapter titles (14 pt Arial bold, all caps,
flush left). Appendix pages should be numbered as part of the report—for example, if the last page of
the report is 67, the first page of the appendix would be 68.
9
Download