Project Information#

Proposal Template#

If you have selected to do a project, please use the following template to add a section to the end of your contract.md

## < Project Tite >

<!-- insert a I sentence summary  -->

### Objectives

<!-- in this section describe the overall goals in terms of what you will learn and the problem you will solve. this should be 2-5 sentences, it can be bullet points/numbered or a paragraph  -->

### method

 <!-- describe what you will do , will it be research, write & present? will there be something you build? will you do experiments?-->

### deliverables

<!-- list what your project will produce with target deadlines for each-->

The deliverables will depend on what your method is, which depend on your goals. It must be approvd and the final submitted will have to meet what is approved. Some guidance:

  • any code or text should be managed with git (can be GitHub or elsewhere)

  • if you write any code it should have documentation

  • if you do experiments the results should be summrized

  • if you are researching something, a report should be 2-4 pages in the 2 column ACM format.

This guidance is generative, not limiting, it is to give ideas, but not restrict what you can do.

Updates and work in Progress#

These can be whatever form is appropriate to your specific project. Your proposal should indicate what form those will take.

Summary Report#

This summary report will be added to the grading contract repo as a new file project_report_title.md where title is the title from the project proposal.

This summary report have the following sections.

  1. Abstract a one paragraph “abstract” type overview of what your project consists of. This should be written for a general audience, something that anyone who has taken up to 211 could understand. It should follow guidance of a scientific abstract.

  2. Reflection a one paragraph reflection that summarizes challenges faced and what you learned doing your project

  3. Artifacts links to other materials required for assessing the project. This can be a public facing web resource, a private repository, or a shared file on URI google Drive.

Project Examples#

  • One type of project would be to do a research project on a topic we cover in class and create a .md file with your findings that demonstrates your knowledge of the topic. The .md file would include an Abstract, Body, Reflection including what you did and what you learned from it, and a Bibliography. Potential research topics include:

    • Motherboards

    • CPUs: Their History, Evolution, and How They Work

    • GPUs: A Graphics Card That Revolutionized Machine Learning

    • The Differences Between Operating Systems: MacOS vs Windows VS Linux

    • Abstraction For Dummies: Explaining Abstract Concepts to the Layman

  • Another type of project could be to create a program using the tools taught in class to maintain the program. What would be included in this would be a .md reporting your findings that demonstrates an understanding of the tools used and a link to the repository hosting the program including documentation written for the program.