CS375: Software Engineering - Final Report (100 Points)

Assignment Goals

The goals of this assignment are:
  1. To prepare a final user and technical manual for a medium-sized software project

The Assignment

The final step in your software project is documenting the work that you’ve done so that a) non-technical audiences can use your software, and b) technical users can deploy, maintain, and enhance your project.

You might consider writing the report in a way that would have benefitted you months ago when you first started the project, or in a way that would benefit you a year from now when you’ve forgotten all the details. Screenshots and figures are essential here, as you are communicating your work to a broad audience.

Code Coverage Report

In this report, include the results of your test plans: execute your unit tests, and indicate how many passed. Also include the code coverage report. Indicate the results of each user acceptance test that your stakeholders (or, if they are unavailable, your project group members) executed.

Website

Include your report on the project website.

Submission

In your submission, please include answers to any questions asked on the assignment page in your README file. If you wrote code as part of this assignment, please describe your design, approach, and implementation in your README file as well. Finally, include answers to the following questions:
  • Describe what you did, how you did it, what challenges you encountered, and how you solved them.
  • Please answer any questions found throughout the narrative of this assignment.
  • If collaboration with a buddy was permitted, did you work with a buddy on this assignment? If so, who? If not, do you certify that this submission represents your own original work?
  • Please identify any and all portions of your submission that were not originally written by you (for example, code originally written by your buddy, or anything taken or adapted from a non-classroom resource). It is always OK to use your textbook and instructor notes; however, you are certifying that any portions not designated as coming from an outside person or source are your own original work.
  • Approximately how many hours it took you to finish this assignment (I will not judge you for this at all...I am simply using it to gauge if the assignments are too easy or hard)?
  • Your overall impression of the assignment. Did you love it, hate it, or were you neutral? One word answers are fine, but if you have any suggestions for the future let me know.
  • Using the grading specifications on this page, discuss briefly the grade you would give yourself and why. Discuss each item in the grading specification.
  • Any other concerns that you have. For instance, if you have a bug that you were unable to solve but you made progress, write that here. The more you articulate the problem the more partial credit you will receive (it is fine to leave this blank).

Contract Grading

To Receive an A

  • Each item required for a grade of B is included
  • The project website includes the final software report
  • The report is written to a standard such that it represents the culmination of knowledge that the group would have wished for prior to starting the project.
  • The report includes results from stakeholders or group members executing the user acceptance test plan

To Receive a B

  • Each item required for a grade of C is included
  • The report includes figures and tables as appropriate to communicate with their respective audiences
  • The report includes a code coverage report from the software test plan indicating full test coverage
  • The user section of the report is written in a non-technical way

To Receive a C

  • Each item required for a grade of D is included
  • The technical report section describes how to deploy the system, and the user report section describes how to operate the software

To Receive a D

  • Both the user and technical sections are included in the report

Please refer to the Style Guide for code quality examples and guidelines.