This page describes the deliverables for Senior
Project. Deviations will be announced in class and will also be posted
on the notices page. The objective is to not
overload you with paper work. Hence, there are page limits for each
document.
Project website:
All groups will set-up and maintain a password-protected website dedicated
to their project. The URL and password should be shared with all team
members, company representatives, and the instructor. All documents and
software deliverables listed below (that is, status reports, requirements
document, and etc.) will be made available on this website. Previous versions
of all documents, etc. will also be stored and be accessible via this website.
Instructions on how to set-up a password protected website are
here. This website should be set-up in the
first week of class. A barebones example in HTML (for you to build on!) is
here.
Weekly status report:
Do you know what you are going to do next week - that is, what are your goals?
Do you know what you accomplished this week? if you were unable to accomplish
your goals, do you know why and do you have a plan to fix problems? Each group
will submit a short status report every Friday. The template for this
status report is here. Page limit is 1
page.
Requirements document:
Do you know what problem you are solving? Do you know what your customer
needs and wants? In order for your project to be successful, you must
concisely and precisely describe the project requirements. You must also
identify any engineering standards that are applicable to the problem you
are solving. Requirement items must be numbered so that they can be traced
throughout the project. Traceability is key to the success of large projects.
Page limit is 2 pages (plus appendices as needed).
Peer design review presentation and feedback:
Real projects always have design reviews. Here you present to your peers
the problem (requirements), your proposed solution (specification/design), and
an analysis that your solution is a good one. Your peers critique your design
and provide useful feedback. In a peer design review, everyone learns from
everyone else. Presentation time limit is 12 minutes. The template
for a design review presentation is here. The
design review feedback form is here.
Specification/design document:
Do you know how to solve the problem and meet your requirements? This
document should clearly describe the solution and include a design. A design
could be a high-level flowchart or a hardware block diagram. For software
with a user interface, a design should contain mock-ups of the user
interface. The document must include details on the methods what will be
used to solve the problem and complete traceability to all requirements.
The customer must be convinced that you have a workable and feasible design
(i.e., that you know how to solve their problem in a feasible manner). Your
specification must make it clear that you have handled design constraints that
apply to your project including economic, environmental, social, political,
ethical, health and safety, manufacturability, and sustainability. You must
also address that you have incorporated appropriate engineering standards in
your design. Specification items must be numbered so that they can be traced
throughout the project (a traceability matrix is required). Page limit is
2 pages (plus appendices as needed).
Prototype demonstration:
This is a major checkpoint. You must have something up and running.
A prototype is something you can show your customer and ask "is this what
you wanted?". The customer must be able to see that all features are
in place (but, perhaps not fully working). For software, a prototype
should include all user interfaces.
Test plan document:
How do you know you met the requirements (validation)? How do you know
you implemented the specification and design correctly (verification)?
Describe your test cases for validation and verification. A test case
must include the requirement or specification number that is covered,
procedure to execute, and expected results. Good test cases should
cover expected and unexpected inputs. A good test plan will show complete
traceability to all requirement and specification items (a traceability
matrix is required). No page limit, but should be short.
Final presentation and submission of deliverables to instructor:
Your final presentation and demonstration to the instructor is in the last
week of classes (time limit is 30 minutes). The template for a final
presentation is here. Your final submission in
hardcopy form contains revised versions of all of the above documents, your
presentation overheads, your product (i.e., your "artifact" as produced
software and/or hardware), and any final documentation that is required (e.g.,
user documentation if a software product, complete specifications if a
hardware product, and so on). Your final submission also includes a poster
and a press release.
Poster - The poster is a self-explaining presentation of your
project. The poster may be displayed in the hallways of ENB 3rd floor
for at least one semester and also publically posted on the web. The
template for the poster is here.
Mini press release - The press release is a maximum 150 word
description of your project suitable for a university newsletter or website.
Unlike the other deliverables, the press release may be somewhat self promoting
and "salesy". Include one picture or image with your press release. The writing
of a press release will be discussed in lecture. Very likely, some of these
press releases will be used in a university newsletter or website.
Final presentation and demonstration to company:
Your final presentation and demonstration is given to your company supporter
at the company site. You will deliver (or "ship") your final product
to the company at this time. Your class grade is dependent on this final
step.