General Report Guidelines

Title Page

All formal reports must contain a title page that includes project identification, company name, course, names of members, and date submitted. Additional appropriate information may be displayed at the team's discretion including team name, department name, and advisor.

Table of Contents

A table of contents is generally required. It is recommended that you use your tool's features to automatically generate and update the table of contents. Note that the cover page is never allocated a number. The front matter is usually numbered with lower-case Roman numerals, and page number one is the first page of the document body. If a report is only a few pages long, a table of contents may be omitted.

Captions

Good figure captions are typically at least one sentence long and often several sentences beyond the title. The caption summarizes or interprets the figure for the reader and is a basis for discussion of the figure in the body text. All figures and tables require a caption. All figures and tables must be referenced within the body of the report. Do not use relational references, e.g., “the figure below.”

Quantities and Units

Write quantities and units in IEEE style, ideally with a non-breaking space between numbers and units. See IEEE style guide, especially 14.2.d and 14.4. Unfortunately, usage varies greatly throughout the popular literature, and even some technical literature is not consistent. Mind case especially in units. Some examples:

  • “20 km” (not “20km”, “20 Km”, etc.)
  • MB/s is megabyte/second
  • Mb/s is megabit/second

Generally, numbers less than 10 are spelled out. Numbers 10 and larger use numerals.

Hyphenation

Be sure to use the hyphen correctly. A very common error is forgetting a hyphen in adjectives, e.g., 12-bit converter.

References

There are many online references. Here are a couple good ones:

seniordesign/deliverables/generalreportguidelines.txt · Last modified: 2010/04/30 20:12 by taylor
 

This website is not owned or managed by the Milwaukee School of Engineering.

© 2003-2010 Dr. Christopher C. Taylor, et. al. • Office: L-343 • Phone: 277-7339 • npǝ˙ǝosɯ@ɹolʎɐʇ • -> RSS <-