Project-Based Software Engineering, Project Reports |
To avoid confusion about the reports that are expected from the time accounting system they are summarized below. Notice that these are the required reports, the decisions about exact format, possible other reports are up to you.
You might also notice that the descriptions are not clear "requirements." Instead, they are descriptions that you might get from the customer. Based on these descriptions you should try to figure out the real requirements so that the report development becomes straightforward design and implementation task.
The monthly report is intended to be send to the customer with the bill for the reported month. Thus the report should indicate all the things that have been done during that month so that the customer gets a clear idea what has been done and how much time each task has taken. Also, the sum of total time used during the month should be visible on the report. Normally a reporting month is standard calendar month.
The time distribution and cumulative time diagrams should be available for the whole project duration. The respective data tables need not be included in the report.
Overview
The final report is generated from the time accounting software by pressing a button or through a menu selection. First a "Save As" dialog is shown with a default file name and selecting OK creates the file in the given folder.
The file must have the format specified below and all the inputs must have default values. Thus it is possible to create the file with basically two mouse clicks: first the "Final Report" button in the main application and the "OK" button in the Save As -dialog.
Final report format
The final report must be an ASCII file with the following format (file name "0299999ShW.FR"):
StudentNo: 0123456 LastName: Shakespeare FirstName: William HoursTotal: 100,5 HoursLectures: 30,0 HoursQuizzes: 10,0 HoursExercises: 20,0 HoursProjectc: 30,5 HoursOther: 10,0
The line headings start from the first column, each heading and value is separated by a single tab-character, and the line ends after the value. There are no leading or trailing spaces in the lines nor empty lines in the file.
The lines must be in the order shown above. The HoursTotal must be equal to the sum of the following Hours-lines. If your time keeping doesn't have exactly the same categories as specified above you should do a mapping to these categories. The hours must be saved with 1 decimal accuracy and the decimal separator is comma.
The LastName and FirstName must be the same ones as you used for registering to this course.
The default name for the file identifies the person whose data is in the file. It uses the same format as all other project deliverables (student number + initials + .FR). The file name extension is FR for "Final Report". Since this project is individual you could hardcode the default filename. For example, for the file above the default filename would be "0299999ShW.FR".
The default directory for saving the file must be the same directory as the current workbook directory. This means that despite the directory where your software is located it always suggests the same directory for the final report.
Last updated 16.10.2002