College of Arts and Sciences
Department of Computer Science                                    

Senior Project
Project title

Team members
email addresses/web pages for team members
Sponsor:

Introduction | Schedule | Related Work | Specification Document

| Design Documents | Developed Tutorials | Coding Guidelines | Downloads | Future Work

 

INTRODUCTION

This should contain a 2-3 paragraph high-level description of your project. It should serve as a quick summary for someone who is just learning about your project for the first time, and should address the following questions: What is the problem you're working on? How are approaching this problem? Who are the clients? Who will benefit from this project? What are your goals?
 

OBJECTIVES

Here you should spell out in more detail what you plan to accomplish this semester. Break things down into measurable tasks that have an identifiable endpoint. For example, develop a GUI for the application, or implement a caching system, or add a new feature to an existing application. Most projects should have several objectives.

 SCHEDULE

When is your group planning to meet? If you have an outside sponsor, when are you meeting with this person?

 

General Project Timeline

A Week-by-week breakdown of the high-level subgoals of your project.
Week
M 1-27 Choose a project
M 2-3   Rough draft of specification and web page
M 2-10  
M 2-17
M 2-24 Design and Code Walkthrough
M 3-3
M 3-10 Midterm Presentations
M 3-17 Spring Break
M 3-24
M 3-31
M 4-7   Design and Code Walkthroughs
M 4-14
M 4-21
M 4-28
M 5-5
M 5-12   Final Presentation 

Scheduled Deliverables

Here, you should keep a running list of the deliverables you are working on, have completed, and are planning to implement. This should include due dates, who is responsible for each deliverable, and links to completed deliverables.

Each week, you should update and modify this list as your project evolves.

RELATED WORK 

This section should contain links to related work. This could involve software or techniques that you will be using, papers by other researchers working on similar problems, past incarnations of your project, or more general references. Each link should be accompanied by a short (1-2 sentence) description of the work and its relation to your project.

Example:

An Algorithm for Widget Construction. Anne Elk. Journal of Widgets and Grommets, 12(1), p 335, 1999. In this paper, the authors describe an efficient algorithm for building a widget based on user preferences. Like our project, the authors are interested in building customized widgets; however, they are focused on the theoretical properties of widget-building algorithms, as opposed to implementation.

SPECIFICATION AND DESIGN DOCUMENTS
This section is key. This is where you will describe the details of your project. The particulars will vary depending upon the details of the project, but some things that I would expect to see include:
  • Any requirements your project must adhere to, such as standardized data formats or style guides.
  • Structure Charts or Class Diagrams detailing the static design of your classes.
  • Sequence diagrams describing how your application will behave dynamically.
  • Documentation for your code. For example, javadocs.
  • Documentation describing how to use your system.
  • Description of any relevent designs, algorithms or techniques.
Back To Top

DEVELOPED TUTORIALS  

As you figure out some technique or piece of technology, you'll want to produce a piece of documentation that a) shows the work you've done and b) puts what you've learned in writing. In this section, you should include short (about 1 page) tutorials for this aspect of your project. You can also link here to online tutorials/resources that you've found helpful.

Examples:

Back To Top

CODING AND DESIGN GUIDELINES

If there are any external design guidelines you are following, you can include them here. For example,

Code Conventions for the Java TM Programming Language - Code Conventions from Sun Technologies

Javadoc supported comments will be maintained throughout the java code.
 

DOWNLOADS

Any developed programs, samples, screenshots or results can (and should be) linked here.

FUTURE WORK

 

This is where you'll include all the ideas you didn't get to, and the things that the next group to tackle your project should think about.

Back to Top