Download Artificial Intelligence - Final Project Report | CS 179M and more Study Guides, Projects, Research Computer Science in PDF only on Docsity!
CS179M: Project in Computer Science: AI Fall 2005
Final Project Report
Due December 9, 2005
Your group must submit one final project report. It will be turned in as a physical report, bound in a three-ring binder, or similar. Each page must meet the following layout specifications.
- Minimum of 10-point font
- Minimum of 1-inch margins (all four sides)
It must contain at least the following sections (rough number of pages in parentheses).
- Title Page (1)
- Statement of Original Work (1)
- Description of Artifact and Purpose (2)
- User’s Guide (7)
- Technical Design Specifications (7)
- Maintenance Program (5)
- Future Improvements (2)
- CD-ROM
Title Page: The first page (or cover) should contain the project title, the group’s name, the names of the members of the group, and the members’ e-mail addresses.
Statement of Original Work: Immediately following the title page should be a page with the following statement (or an equivalent) signed by all members of the team.
We, Team B-and-B consisting of Harry Q. Bovik and Foona Barus, attest that this document and the work described here in is entirely our our work. Any known relationship to other work is specifically cited and documented.
If your project builds directly on other sources (as is probably the case), the statement above can be amended to make such relationships clear. If you are uncertain in any way about this statement, ask the TA or instructor.
Description of Artifact and Purpose: This section should describe the constructed engineering project and its purpose. It need not be overly technical, but it should be specific and detailed. A reader of only this section should understand whether your project addresses his problem and whether he should read farther to find how how to employ your solution.
User’s Guide: This section should describe how to employ your project to its full potential. It should not make reference to any unnecessary technical details (such as those in subsequent sections). While it took three seniors in computer science to design and build the project, presumably it does not take a degree in computer science to operate your creation. Write this section for users of your artifact. It should stand alone as a user’s guide: the instructor should be able to hand this user’s guide and the software to his mother and she should have no trouble employing the software.
CS179M: Project in Computer Science: AI Fall 2005
Technical Design Specification: By contrast to the previous section, this section should be written for a computer science graduate. It should be clear about each and every detail of the project and how all of the pieces go together. A programmer, after reading this section, should be able to edit your code without difficulty. This includes and modifications listed in subsequent sections, as well as any other modifications he might chose to explore. This section may assume knowledge of previous sections.
Maintenance Program: This section must address the long-term viability of your project. Unlike struc- tural buildings, code is not subject to rain, wind, and oxidation. However, it is subject to man-made forces including changing user bases and the evolution of dependent and depending technologies. This section should predict, to the degree possible, future maintenance that your project will require.
Future Improvements: No project is ever completely finished, especially in a mutable environment like software. Use this section to describe future improvements and modifications.
Other Sections: You may add other sections as the nuances of your project dictate. An appendix of code is neither required nor desired. Technical derivations or other supplemental material is well-suited for its own section if it can stand alone.
CD-ROM: Attached to the report should be a CD that includes all code and other software necessary to make the project work. It should also contain a soft copy of this report.
Each of the above sections describes the project from a different viewpoint. Therefore, they should be structured differently. Think carefully about how to best layout your exposition before starting a section. The instructor and TA will be happy to go over your final report with you prior to its due date. However, do not wait until the last moment, as then you will have no way of incorporating the suggested changes.
Grading: Each section will be graded based on clarity and completeness. Diagrams, screen shots, and other pictorial representations are highly encouraged when they support clarity. Sections should probably be further divided for clarity of exposition.
