Skip to content

Commit

Permalink
docs: add design for stage selection modal for tutors in ontrack dash…
Browse files Browse the repository at this point in the history
…board
  • Loading branch information
coskun-kilinc committed May 17, 2024
1 parent 6e52a38 commit 6bc28e7
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions docs/OnTrack/Feedback Enhancement/desing stage option selector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
## Design Feature to Insert Feedback Stages into Comments in OnTrack

![OnTrack Dashboard with Stage Selection Modal Open](<images/Screenshot 2024-05-15 at 21-40-57 OnTrack.png>)

### Tutors' View

- Tutors can access a new "Stage Selection" modal when adding comments in the OnTrack dashboard.
- Within this modal, tutors have options to select relevant feedback stages for students.
- Tutors can select multiple stages such as "Use of Structs and Enumerations," "Code Quality,"
"Functionality," "Discuss," and "Resubmit." (Example only, stages are input by the unit chair when
creating the task).
- Each stage is displayed with a checkbox, allowing tutors to select one or multiple stages.
- Tutors can submit their selections, which will be included in the student's feedback.

![OnTrack Dashboard with Stage Selection Modal Open with blue title bar](<images/Screenshot 2024-05-15 at 21-48-52 OnTrack.png>)
![OnTrack Dashboard with Stage Selection Modal with 2 out of 4 checkboxes selected](<images/Screenshot 2024-05-15 at 21-49-28 OnTrack.png>)

### Features and Interactions

- **Stage Selection Modal**:

- Accessible only by tutors.
- Tutors can open the modal when adding comments.
- Tutors can see a list of predefined stages to provide structured feedback.
- Each stage has a checkbox to allow multiple selections.

- **Buttons**:
- **Insert Stages**: Confirms the selection and adds the stages to the comment.
- **Cancel Stage Selection**: Closes the modal without saving any changes.

![](file-MncfO9nfxycwNQ3jPWmrHYet) ![](file-iZF5AacEqtGleeQQB1qvwsOD)

### Workflow

1. **Open Stage Selection Modal**:

- Tutors click on the comment section to open the stage selection modal.

2. **Select Stages**:

- Tutors check the boxes next to the relevant stages.

3. **Insert Stages**:

- Tutors click the "Insert Stages" button to include the selected stages in the student's
feedback.

4. **Cancel Selection**:
- Tutors can cancel the selection by clicking the "Cancel Stage Selection" button.

### Security and Access Control

- The stage insertion modal is completely invisible to students and can only be accessed by tutors.

### Benefits

- Provides structured and consistent feedback to students.
- Enhances the clarity and effectiveness of feedback.
- Saves time for tutors by providing predefined feedback options.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6bc28e7

Please sign in to comment.