anselmlong / pe

0 stars 0 forks source link

[UG] The entire premise of assignments is unclear #18

Open anselmlong opened 1 week ago

anselmlong commented 1 week ago

Overview:

There is no mention of what an assignment is, what is it for, as well as details about the submission status. As a user, I'm not clear about what I need this feature for, and even how to use it.

Environment:

Processor: 13th Gen Intel(R) Core(TM) i5-13500H, 2600 Mhz, 12 Core(s), 16 Logical Processor(s) Operating System: Microsoft Windows 11 Home Version 10.0.22631 Build 22631 App Version: v1.6

Steps to Reproduce:

Expected Result:

Actual Result:

Screenshots/Logs (if applicable):

image.png

Frequency:

nus-pe-script commented 1 week ago

Team's Response

We believe that the term "assignment" is self-explanatory.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Although the term "assignment" is self-explanatory, as a user reading your user guide, I don't just want to know the commands, but I want to know how your program tracks such assignments, and how can this benefit me. The section here has no descriptions of the intended behavior of the program, just the commands.

I believe this section can benefit from a short description of the functionality, along with screenshots and more examples - all the commands here have no examples well. For example, a short description like: "You can add assignments for your students, as well as track the submission status of them. Other than adding assignments for individual students, you can add assignments for your entire tutorial group, allowing you to track and account for the different submissions you have easier." "Adding assignments look like this:

" Such elaborations and screenshots would make your user guide more fit-for-purpose! However, I do agree that this can be downgraded to a low severity, but this entire section was quite unclear to me as I was testing the product.
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]