Difference between revisions of "Final Report Guidelines"

From ESE205 Wiki
Jump to: navigation, search
Line 3: Line 3:
  
 
== Content ==
 
== Content ==
 +
The objective of your final report must be to provide all the necessary information so anybody that is interested can reproduce your project.
 +
Please keep this goal in mind when you describe each of the steps you took to complete your project.
 +
 
Your final wiki page must, at least, contain the following sections:
 
Your final wiki page must, at least, contain the following sections:
 
# Proposal (the same you wrote months ago)
 
# Proposal (the same you wrote months ago)
Line 18: Line 21:
 
#* Discuss how the results compare to your original objectives.
 
#* Discuss how the results compare to your original objectives.
 
#* Identify the critical decisions or factors in your project that stopped you from getting a better result (try to avoid obvious comments such as ''"we run out of time"'').
 
#* Identify the critical decisions or factors in your project that stopped you from getting a better result (try to avoid obvious comments such as ''"we run out of time"'').
 +
 +
== Source Code and CAD files ==
 +
You '''should not''' include huge chunks of source code in your final report.
 +
Instead, you should upload your source code to a public repository (e.g., [//github.com/ GitHub] or [//bitbucket.org/ Bitbucket]), and then provide a link to that repository in your final wiki.
 +
 +
Similarly, if you used the 3D printer then you should post the final versions of your CAD files in a public repository for 3D printer parts (e.g., [//thingiverse.com/ Thingiverse] or similar), or simply use the same repository that you used for your source code.
 +
 +
Please note that your code and CAD files must be, at least, minimally documented so it is clear how they are executed, and what is the purpose of each module or class in your program.
  
 
== Evaluation ==
 
== Evaluation ==

Revision as of 19:28, 25 April 2017

On Tuesday May 2 at 5pm the project pages will be locked, disabling any further changes. That is, the version posted on May 2 at 5pm will remain posted for as long as this wiki exists.

Content

The objective of your final report must be to provide all the necessary information so anybody that is interested can reproduce your project. Please keep this goal in mind when you describe each of the steps you took to complete your project.

Your final wiki page must, at least, contain the following sections:

  1. Proposal (the same you wrote months ago)
    • Overview.
    • Team Members.
    • Objectives.
    • Challenges.
    • Gantt Chart.
    • Budget.
  2. Design and Solutions
    • Description of each module of your project, and the solutions you designed to complete them.
    • If you had to learn a new skill to solve a problem (e.g., how to install a particular API, how to communicate using Bluetooth, etc.), then you must create a new HowTo wiki page with a clear tutorial of what you learned.
      Add each of your HowTo pages to Category:HowTos by including the following code at the bottom: [[Category:HowTos]].
  3. Results
    • Present all your results, including modules that only partially worked.
    • Discuss how the results compare to your original objectives.
    • Identify the critical decisions or factors in your project that stopped you from getting a better result (try to avoid obvious comments such as "we run out of time").

Source Code and CAD files

You should not include huge chunks of source code in your final report. Instead, you should upload your source code to a public repository (e.g., GitHub or Bitbucket), and then provide a link to that repository in your final wiki.

Similarly, if you used the 3D printer then you should post the final versions of your CAD files in a public repository for 3D printer parts (e.g., Thingiverse or similar), or simply use the same repository that you used for your source code.

Please note that your code and CAD files must be, at least, minimally documented so it is clear how they are executed, and what is the purpose of each module or class in your program.

Evaluation

The evaluation of the final wiki page will follow the same lines as with regular reports. That is:

  • it must be well organized and clearly written.
  • you must use references when needed.
  • figures must have captions, and be clearly explained.

Each group must write at least one HowTo (most projects can easily write two), which will be evaluated as part of the final report. Be original with your final wiki page, use videos, diagrams, and pictures to replace long (potentially boring) explanations. Aim for depth rather than length in your report, a good short explanation is always superior to a long dense paragraph.

Finally, all the equipment purchased with ESE funds must be returned and added to the inventory. Please coordinate with your TA to make the final inventory before the report's deadline. Remember to let us know of any parts that failed or broke so we can take them out of the inventory.



If you can't explain it simply, you don't understand it well enough.
- Albert Einstein