Recent Changes - Search:

Home Assignments Lecture Blog Resources Project

91.301 Organization of Programming Languages
Prof. F. Martin

Final Project Writeup - Due Thu Dec 11, by 9am

In this assignment, you will document your OPL final project. This will be done on the class wiki site using a provided template. I will make copies of your documentation to be handed out during the open-house.

Also, you will separately turn in your code using the UML submit system.

Part 1: Project Report Template

Below is the wiki markup you should use as a template for your writeup. To use it, do the following:

  1. Select all of the markup-text between the horizontal lines, and copy it to your clipboard.
  2. Click edit to edit this page. The edit password is posted to the class Google group.
  3. Add your project title as a wiki link, and your name to the bottom of this page per the directions there.
  4. Save the page.
  5. Click on the newly-created link to your project writeup.
  6. At that page, click edit.
  7. Paste the wiki markup-text into your project writeup page, and Save.

You now have the framework for documentation your project. You can re-edit your page as often as you like. Follow the directions in the template for uploading your screen shot. 

'''Your Name''' \\
December 10, 2008

!!Overview
A brief description of the project is given here.  The description is
1 to 3 sentences long.  Be concise and clear.

!!Screenshot
%width=600px% Attach:fgm-screenshot.png

(You may attach a PNG, GIF, or JPG file.  Please note the @@Attach:@@
syntax for doing this.  After you save the wiki page, you will see the
@@Attach:@@ link with a blue triangle.  Click on the link, and then
you will be brought to a page where you can upload the
attachment. After you upload the attachment, the link goes away and
you see the image instead.)

!!Concepts Demonstrated
1/6 of the project grade is based on which
concepts from OPL are demonstrated in your project.  Please identify
them here.  Be brief; a simple list and one-sentence explanation for
each concept should be adequate; e.g.:

* ''Data abstraction'' is used to provide access to the elements of the RSS feed.
* The objects in the OpenGL world are represented with ''recursive data structures''.
* ''Symbolic language processing techniques'' are used in the parser.

!!External Technology

Another grading category is the "extent to which project integrates
with some external technology." Briefly mention this here.  If your
external technology is a Scheme library, describe it.

!!Innovation

Describe what is innovative about your project.  

!!Technology Used Block Diagram

Create a simple block diagram of your software system that illustrates
the major technical components and how they interact; e.g.:

%width=600px% Attach:fgm-block.png

!!Additional Remarks

Please use this area to include any additional information you would
like to include that did not fit into any of the previous categories.

Please note that the entire writeup, including screen shot and block
diagram, should be no longer than 3 pages in length.

Part 2: Code Turn-In

After the project is complete, get all of the source files together.

  • Create a README.txt file that lists all files that you are submitting
  • Includes a sentence or two that explains what's going on in that file.
  • Indicate which files are ones that you performed substantial work
  • Also include one or several introductory paragraphs that explain the overall structure of the code.

Zip or tar up all of the source files and the README and submit to assignment 301-fpcode on mercury: 

  submit fredm 301-fpcode files.tar

This is due Monday, December 15.

Writeup Links

Edit the Project page and add a link to your write-up there. Note: you can add the link before your writeup exists; then after saving the page, clicking on the "broken link" will allow you to create your own page.