Main Page
|
Course Admin
|
Course Resources
|
Rules & Regulations
|
Team Profiles
|
Photo Gallery
|
Contact Info
 
  You are here: RoboFlag Main Page > Course Resources > Report and Presentation Information > Final Report Suggestions


Final Report Suggestions

Based on the notes I used when grading final reports from the '99/'00 project, RoboTag, I've compiled a list of suggestions that you should thoroughly read and understand before you submit your final report.

Be sure to reference the Preparing a Fourth-Year Design Project Final Report article for more information regarding the final report.



Report Headers:
  • use the headers as shown below, or something like the IEEE format, but don't ever change the style of your headers mid-document
  • try to avoid going to a fourth level of sub-headings (ie: 1.1.3.2), instead, try using bolded sub-headers inside the 1.1.3 section
  • don't use periods or incorrect capitalization on your titles


Style Tips:
  • avoid unnecessary words:
    • "in order"
    • "to be able"
    • "hence"
    • "basically"
  • look up how to write reports using "information mapping"


DO:
  • DO make three copies of your final report: one for the supervisor to grade, one for the second marker to grade, and one for yourself!
  • DO get all three copies professionally RING bound, so the report can sit open on a desk while being read; if you bind the report with a book-like binding, it will upset the markers
  • DO capitalize the words Table and Figure in your report, and refer to tables and figures as follows:
    • "... so the wheels are small (Figure 3.1) compared to the others available, as shown in Table 3.1."
  • DO understand the difference in meaning between the words "it's" and "its" - double check if you have problems
  • DO spell out any numbers below 11 (ie: one through ten), and DO use numerical characters for any number above ten (ie: 11 and up), EXCEPT for 6V, 3A, or other measurements or data points


DON'T:
  • DON'T quote the rules (ie: quoted verbatum, indented paragraph, etc), but rather include them as an appendix, IF REQUIRED
    • are the rules really required as an appendix? would a web reference work as well (or better)?
  • DON'T use the rules (in an appendix) as an explanation of the project! you need to explain and outline the important rules (ie: ones that drive your design decisions or strategy) in plain english
  • DON'T contradict yourself within the report, especially in regards to what you did, what your accomplishments were, and how your robot performed in the competition; be very clear about what happened at all times
  • DON'T include any "use cases" unless you're absolutely sure how they're supposed to be used, and you're absolutely sure they help you explain what's going on
  • DON'T include "use cases" as a method of explaining the competition or what your robot will be doing, spell it out!


Topic Checklist

The following checklist is supplied as a non-authorative list only. Don't assume that by covering all the points below that your report will be complete. Refer to the report guidelines available in the Report and Presentation Information webpage.

Executive Summary

  • intro project
  • intro team
  • outline the strategy
  • outline the implementation
  • some tech details
  • what you did ***
  • your results ***

Introduction

  • intro project/course
  • list report, sections, goal, team
  • more implementation and tech details

Objectives

  • what did you intend to do
  • project goals, course requirements (team)
  • specifications and compliance (team)
  • tech details (personal)
  • strategies, etc. (personal)

Technical Stuff

  • insert intelligent thought here

Conclusions

  • brief review on the project, course, etc
  • what you did ***
  • what worked, what didn't
  • how the robot performed in competition
  • the experience & practical conclustions
  • review the project goals/objectives

Recommendations

  • what should have been done differently
  • what would have been interesting to try
  • what others should do to extend your work
  • recommendations to improve the course

 

 
Main Page
|
Course Admin
|
Course Resources
|
Rules & Regulations
|
Team Profiles
|
Photo Gallery
|
Contact Info