B. Technical Report Guidelines:
- Report Organization: Reports must include (minimally):
- Cover Page: with all appropriate information
- Table of Contents: with pagination identified
- Executive Summary: a freestanding, concise summary of project
objectives and results. Freestanding means that the Executive
Summary can be extracted and submitted as an independent report.
- Report Body: Report content should comprise sections that are clearly
labeled, thoughtfully written, and well organized (use an appropriate
hierarchy in labeling sections and sub-sections). All tables and figures must
be referenced in the text or placed in an identified appendix.
- Appendices: (see below).
- Report Body Sections:
There are two options, depending on the topic and tasks. Most research topics
have a single thesis and approach and should thus follow Option 1. Most project
topics have multiple tasks and should follow Option 2.
Option 1 [single thesis/task]
- Introduction: A clear and concise summary of the problem and the approach
to solving it (may include a brief summary of the subsequent sections of the report)
- Methodology: What are the methods, models, and data to be applied?
Describe in appropriate detail. Quote relevant literature.
- Results: What are the results of your analysis, presented relevant
to the defined problem and work tasks? What do they mean?
- Summary, Conclusions, and Recommendations: Provide a summary of the
project and of specific results. Draw overall conclusions, in reference to
the defined problem and solution approach taken.
- References: [Harvard format, e.g, "...Smith (1998)..." or "...some studies (Smith, 1998)..."]
- Appendices: Provide documentation of secondary importance.
Appendices are not usually read.
Option 2 [multiple tasks such as CEE123]
- Introduction: A clear and concise summary of the problem and the approach
to solving it (may include a brief summary of the subsequent sections of the report)
- Task 1: define tasks objectives, approach, and results, and then summarize.
- Added tasks: repeat as for Task 1; new tasks on new page,
preferably in a new tabbed section.
- Summary, Conclusions, and Recommendations: Same as for Option 1
- References: Same as for Option 1
- Appendices: Same as for Option 1
- Tables and Figures:
- Use tables and figures to graphically emphasize and display key material
and results. For example, if you have estimated several alternate models,
create a summary table that facilitates model comparison. Be sure
to include relevant statistics (such as t-scores and coefficients).
- Tables and figures must stand alone. Label fully so that the
graphic is understandable without referring to the associated text.
- All tables and figures must be referenced and discussed in the text.
When referring to particular results in a table or figure, try to
include them on the same page.
- Any results that are not explicitly discussed in the body of the report
should be placed in an appendix. Remember, Quality not quantity!
- Report Editting: Have a teammate or an external party edit your report.
Utilize campus writing resources.
- Report Binding: Requirements vary with specific projects. Preferred
binding comprehensive projects is a 3-ring binder of sufficient width to
allow the material contained to be easily reviewed. All material should be
standard 8.5x11 paper (or folded to 8.5x11). Provide suitable section breaks.
- Electronic Copy: Submit a CD with an electronic copy (e.g., doc or pdf)
of your report as a single, integrated document (depends on specific course).
Include a copy of all data. Label the CD!
- Presentation: Guidelines will be provided if a presentation is required.
|