Download Project Report Requirement for Software Engineering - Fall 2005 | CS 389 and more Study Guides, Projects, Research Software Engineering in PDF only on Docsity! CS389 Project Report Requirement Dr. Lixin Tao April 3, 2005 1. Title page with project title, team members’ names and emails. 2. Role and Workload Assignment page: Who played which roles (team leader, problem analyst, solution designer, programmer, tester, technical writer) and contributed which components of the project? What is the workload ratio of each team member (each member will be assigned a workload ratio, a percentage of his/her contribution to the entire project)? Suppose a team has 5 members. By default, it will be assumed that each member has contributed the same amount to the project, so each member will get workload ratio 20%. If this is not the case, this page must declare it publicly. 3. Problem specification and objectives. 4. Solution methodology. (Using object-oriented approach; taking advantage of an existing software framework for client/server applications; etc.) 5. Requirement document, similar to those on textbook Sections 4.10 and 4.11. This document will include both functional and non-functional requirements, as well as major use cases. 6. Design documents: (1) systematic class diagrams with proper documentation about syntax and semantics of each class as well as the major variables and methods of these classes; explain whether you have applied some design patterns; (2) systematic sequence diagrams, like those on textbook pages 271-273, and state diagrams, like those on textbook page 279. 7. Testing document, like file “Testcases-Phase1.html” for OCSF (under directory “cs389\ocsfChat”), which clearly specify what and how to test. 8. Sample running sessions for major use cases, with clear instructions of how to repeat the same experiments, what are the inputs, and what are the outputs and screen captures. 9. Installation Manual, which makes reference to the attached project in the form of a single zipped file. 10. User Manual covering all use cases as players and as administrators. 11. Known Problems. An honest listing of all known problems that cannot be fixed within the course duration, and suggestions of how to resolve them. 12. Attached zip file for the project source files, documentation files, and the word file for this report. The project must be organized into subdirectories named “src” for source code, “bin” for class files, “doc” for documentations, “image” for graphic images, etc. The top level must contain a “readme.txt” file explaining the organization and where to find each kind of project components.
