Timeshare UserGuide
From PeacockWiki
(diff) āOlder revision | Current revision | Newer revisionā (diff)
Contents |
Purpose of the User Manual
This document is to be delivered to the client in conjunction with the final working system. The user manual educates and demonstrates to the end user how to utilise the features of TimeShare.
The TimeShare system is meant users of varying roles including administrator, supervisor, Project Manager, and student. Therefore separate manuals and guides will be used to teach these groups how to use TimeShare. Each different user will only need to know about the parts of the system they have access to.
This Document should be separated into sections of each user type so that users only get the information that concerns them. The Supervisor and Administrator guides separated from the Project Manager and student guides.
Delivery of the User Manual
The Administration Manual tells the Administrator of the TimeShare system how to install and configure the software, then how to set up the system for general use. This guide would be best followed in hard-copy for ease of reference, portability, and probably only one copy will be needed.
The Supervisor User Manual will teach the different supervisors how to monitor their projects and how to keep in touch with students through feedback and comments. This user guide could also be followed better as hard copy or as a help file.
The Project Manager and Student guide will be combined into one because all group members should know the purpose and process of Status Reporting. This guide would be best suited to a presentation or lecture style delivery with diagrams and maybe a demonstration of the processes involved in using the system for these groups. A soft-copy version will also be available at any time online for later reference and for Distance students.
Students
Clinton 17/10/2005 This should be quick and simple. Something subject coordinators can "copy and paste" into a subject outline. Screenshots, a quick overview.
Project Manager
Clinton 17/10/2005 Again, quick and simple. I will do these two use cases for the userguide. I guess of all of us, I understand the PM's role the best. Well, at least that's what I tell you guys!! (joking!!)
Supervisor
Features, meaning of tables, colours, numbers etc, and feedback
Clinton 17/10/2005 I am guessing this will need most attention. I think Supervisorview1 is the most complicated use case we have to explain. Most of the work is done for this use case with our first user guide, just need to update screen shots I think.
The layout and features of the first page
After logging in as a supervisor using your assigned username and password the following screen will be displayed.
Figure 1: Supervisorā??s home page
The header, footer, and sidebar will stay consistent throughout your usage of TimeShare so the Home page view can always be found again using the home link on the sidebar.
Features of this page include a listing of all of the groups under your supervision, a visual indication on the timeliness of submissions, and navigation links to access groupings of submitted items from students. These groupings include; all items due on a particular date, all items for a particular group, and all items for a date and group of your selection.
The first column in the main view table is the group list containing all group names under your supervision, and links to that groupā??s submissions. The top row of the table is a timeline of submission due dates as links to items submitted on that date. These views are used to navigate to submissions to see what students have been working on and to leave comments for individual timesheets or status reports.
The supervisor is visually alerted to late and un-submitted items by the numbers within each data cell and the cell colour. The numbers represent; number of submissions on time / Number received / number of members in group.
If any one group member does not submit an item and the due date passes, the cell will appear red meaning there is a punctuality issue. When/if they submit after the due date, the cell will turn to yellow meaning it is late but received (better late than never).
In each status report column of each groupā??s row is one of three phrases. These phrases are explained below. Received: The status report for this group was received on time. Late: The status report for this group was received late. Waiting: The status report for this group has not been submitted yet.
View of all submissions for a particular group
To view all submissions made from a group over the duration of the project so far, click on the group name in the first column on the first screen. Below is a screen shot of the view of all submissions made by group 4.
Figure 2: All submissions from Group 4
In each of the defined views, the type of submission can be seen (Timesheet-TS, or Status Report-SR), the group name, the submission number, the duration of time spent on that item, the date it was submitted, and the name of the student who submitted the file, and a view hyperlink to view the details of the file.
View of all submissions for a particular fortnight.
To view all submissions made to the system for a fortnight, click on the date in the first row at the top of the screen on the first screen. Below is a screen shot of the submissions made to the system for the fortnight Aug 28th. Figure 3: This is all timesheet submissions from all groups for the period ending Aug 28th
View a particular groupā??s timesheets for a particular fortnight.
To view a particular groupā??s timesheets for a particular fortnight, click on the series of numbers that corresponds to the date and group name on the first screen. Below is a screen shot of Timeshareā??d submissions for 11-09-05. Figure 4: These are the submissions for Timeshare for period ending Sep 11th
View a studentā??s Timesheet
Using any method described previously, click on the view hyperlink for a particular student. Below is a screen shot of Trevor Peacockā??s timesheet, who is in group TimeShare, for the fortnight 11-09-05. Figure 5: Below is the submitted timesheet for Trevor Peacock for period ending Sep 11th
In this view, the start time and date and the end time and date can be seen. The system calculates the total time spent on this task, task (tasks are set by project managers when filling out status reports), and a description of the work completed.
Adding a comment to an item
Clicking the above ā??add a comment for studentā?? link will result in the following screen appearing. Figure 5: Comment text box
Enter a comment into the text area and press the comment button to leave that comment for the student to see.
Administrator
Software Installation, technical Info, system setup
Clinton 17/10/2005 Quick and simeple. There is nothing too complicated about the admin's role yet. May get a little more complicated with the addition of the setup of project ts and sr schedule.
