Project Report Parts -------------------- I. User Guide -- 3 pages * Describe from a user perspective what should be done to start and use your project. * Include a brief overview for the user as to what he/she should expect in terms of functionality. II. Operating Requirements -- 2 pages * Describe the machines this project was built on and what types of additional software support (and version numbers) are needed and that you installed. * Briefly describe if this project could be done on other types of machines, what type of software would be required (that we might not have), and/or why your project cannot be run on a particular platform. * Include platforms like Solaris for Sun Workstations, Windows NT for the PC, IRIX for SGIs, and maybe other OSs for the PC like Linux, or Solaris x86. III. Technical Project Description -- 8 pages * Obviously the most important part of the write up. And, you can generally organize it how you want. Basically, if you were not given an opportunity to demo the prototype, how would you describe what you've done? Include information that addresses obvious questions like: - what you did - why you did it - what is important about what you've done - what problems you had to overcome - what innovative solutions you came up with NOTE: There is some overlap with Section V below, but notice the difference in scope. In this section the perspective is an accomplishment which is part of the entire project. In Section V the perspective is more from the point-of-view of warning someone who wants to duplicate your efforts. What challenges and pitfalls he/she should keep in mind? IV. Research Ties and Open Issues -- 2 pages * Describe the specific research issues you had to deal with in doing your project; how you dealt with them in the prototype; and how you ideally would/could/should have dealt with them. * This section can be included as a sub-section under Section IV, but the key is to tie your project to research topics either covered in class and/or that exist in the community. V. Implementation Cookbook -- 2 pages * If someone wanted to duplicate your efforts, what would they have to do? This is basically a step-by-step summarization of what was done. Start with the installation of software (if needed) including where the software was obtained (URL), what parts to the project there are, what problems were faced, etc. * Include a breakdown of your project by parts and, where possible, say who did what.