Skip to content
Snippets Groups Projects
Commit 3447b30d authored by Joseph Walton-Rivers's avatar Joseph Walton-Rivers
Browse files

write about writing features

parent b057929b
No related branches found
No related tags found
No related merge requests found
Pipeline #4783 passed
...@@ -51,7 +51,7 @@ Remarks can be used to communicate anything extra to the timetabling team. We us ...@@ -51,7 +51,7 @@ Remarks can be used to communicate anything extra to the timetabling team. We us
## Duplicating Iterations ## Duplicating Iterations
Sometimes, it is neccerary mass-create duplicate iterations (for example, for assessments). You can *right click* on a row to duplicate entries: Sometimes, it is useful to mass-create duplicate iterations (for example, for assessments). You can *right click* on a row to duplicate entries:
![Iteration context menu](../images/iter_dup.png) ![Iteration context menu](../images/iter_dup.png)
......
...@@ -5,3 +5,13 @@ title: Staff Hours ...@@ -5,3 +5,13 @@ title: Staff Hours
When you have a complex module which lots of activies which have multiple iterations and which run over multiple weeks it can be tricky to keep track of the number of hours being requested for staff. When you have a complex module which lots of activies which have multiple iterations and which run over multiple weeks it can be tricky to keep track of the number of hours being requested for staff.
The _staff hours_ view shows the total number of hours across iterations for a staff member. The _staff hours_ view shows the total number of hours across iterations for a staff member.
![Module staff hours](../images/rpt_mod_staff.png)
### Staff Members
Each staff member is listed one per row, the total hours per activity is shown. If a staff member is attached to multiple iterations, the sum of all hours will be shown in the column.
### Activities
Each column represents an activity type. The number of hours attached to each of this activities is shown in each cell.
...@@ -4,7 +4,7 @@ title: Weekly View ...@@ -4,7 +4,7 @@ title: Weekly View
It's useful to see how this module will look when planned out on a week-by-week basis. The tool features a weekly planning report to show this. It's useful to see how this module will look when planned out on a week-by-week basis. The tool features a weekly planning report to show this.
**SCREENSHOT HERE** ![Module staff hours](../images/rpt_mod_sessions.png)
## Weekly Breakdown ## Weekly Breakdown
......
content/reports/images/report_module_activity.png

26.6 KiB

content/reports/images/rpt_module_staff.png

28.2 KiB

...@@ -2,5 +2,4 @@ ...@@ -2,5 +2,4 @@
title: Staff Query title: Staff Query
--- ---
It can be tricky to keep track of which sessions are running in which week across all modules. This view provides the ability to see which sessions a staff member is attached to (for example, for rebalacing workload). It can be tricky to keep track of which sessions are running in which week across all modules. This view provides the ability to see which sessions a staff member is attached to (for example, for rebalancing workload).
...@@ -2,10 +2,18 @@ ...@@ -2,10 +2,18 @@
title: Room Reporting title: Room Reporting
--- ---
Room availablity can be a common issue during the planning cycle. We need to make sure we are making effective use of the spaces available, and are not requesting too much in one location (making it impossible to schedule). This view lets staff see how much has been allocated as guide to aid planning. Room availability can be a common issue during the planning cycle. We need to make sure we are making effective use of the spaces available, and are not requesting too much in one location (making it impossible to schedule). This view lets staff see how much has been allocated as guide to aid planning.
MPyT also has no knowledge of room capacities -- it treats a room pool as a uniform 'block' of hours. It therefore cannot warn about issues relating to capacities, special requirements, etc... (eg, it can't tell the difference between chapel and exchange lecture theatre), which must be resolved after the fact. It also doesn't know about rooms in multiple pools. MPyT also has no knowledge of room capacities -- it treats a room pool as a uniform 'block' of hours. It therefore cannot warn about issues relating to capacities, special requirements, etc... (eg, it can't tell the difference between chapel and exchange lecture theatre), which must be resolved after the fact. It also doesn't know about rooms in multiple pools.
Due to this quite simplistic model, this report is (_very_) optimistic regarding maximum room pool capacities. Real world constraints often mean it is not _possible_ to fully schedule a space at the best of times. Please treat this view as **guide only**. We might be able to improve on this in future iterations, but this will never be perfect (we'd have to handle the full timetabling process for it to be 100% accurate!). Due to this quite simplistic model, this report is (_very_) optimistic regarding maximum room pool capacities. Real world constraints often mean it is not _possible_ to fully schedule a space at the best of times. Please treat this view as **guide only**. We might be able to improve on this in future iterations, but this will never be perfect (we'd have to handle the full timetabling process for it to be 100% accurate!).
**SCREENSHOT HERE** # Room Report
The room report can be found in the *reports* menu, it looks like this:
![Space Utilisation Report](../images/rpt_space_util.png)
### Total Hours
As a **guide**, the total hours column shows how many hours have been requested across the study block. Be aware that perfect utilisation of space is often not possible, and shared spaces may already have allocation attached to them (eg, other departments, rooms in multiple pools, or Exeter usage) and this will not be reflected in the tool.
...@@ -6,4 +6,10 @@ Staff workload considerations are an important part of the planning cycle. This ...@@ -6,4 +6,10 @@ Staff workload considerations are an important part of the planning cycle. This
The 'staff report' is available in the 'Reports' menu and will show a week-by-week breakdown of the activities attached to a staff member. If you want more detail, you can use the [Staff Query](../query) tool to find which sessions are scheduled in a given week. The 'staff report' is available in the 'Reports' menu and will show a week-by-week breakdown of the activities attached to a staff member. If you want more detail, you can use the [Staff Query](../query) tool to find which sessions are scheduled in a given week.
**SCREENSHOT HERE** ![Space Utilisation Report](../images/rpt_staff_usage.png)
This report shows a week-by-week breakdown of the staff hourage by each study block. The _total hours_ column shows the sum of the hours across all modules and activities. This can be used to identify issues with staff workload and working patterns. This is at the granularity of weeks, so if staff have working pattern constraints this will need to also be taken into consideration.
## Hours remaining
As a **guide**, the hours remaining column shows the number of hours allocated vs the workload model hours (assuming an equal split in study block one and two). A positive number assumes there are hours still available, a negative number indicates a possible bias towards this study block.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment