MIT 6.S194 | Open Source Software Project Lab  

Final Report

Due as PDF (email to eob@csail.mit.edu) on May 15.

Length should be roughly 2600 words. Spacing and font up to you. Code samples and figures are encouraged.

Suggested Format

Please organize your paper into the following way (this closely tracks the presentation). Although you worked together as a team for your final presentations, please do your own independent written version for the report.

  • Project Introduction (20%)
    • Concise introduction about the project that you worked on.
  • My Work (20%)
    • What was the nature of your work (several tasks, one task, modifying existing code, create new code, etc)
    • List the units of work that you did for the project.
    • Provide details about one or two pieces of work that you did:
      • What purpose does it serve?
      • What was involved in the technical design and decision-making process?
      • What was your solution? (Feel free to include pseudocode or short snippets)
      • What changes (if any) might be further made in the future?
  • Team Organization (20%)
    • How does your team manage decision making and code review?
    • What elements of this workflow would you adopt in a future project? Why??
    • Which elements of this workflow would you change in a future project? Why?
  • Code Organization (20%)
    • How is your project infrastructure designed?
    • How is the code architecture organized? Is it "anything goes" or intricately organized and structured? How do they reuse and modularize code?
    • What elements of the technical infrastructure would you adopt in a future project? Why
    • What elements of the technical infrastructure would you avoid or change in a future project? Why?
  • Class Debrief (20%)
    • Please make this as an appendix, with a page break before it.
    • Please discuss:
      1. Two aspects of class you would repeat in future years if you were planning it, and why?
      2. Two aspects of class you would change in future years, if you were planning it, and why?
      3. The two most helpful lessons or experiences that you had in this class.