yakultbottle / pe

0 stars 0 forks source link

Save functionality not mentioned in UG #9

Open yakultbottle opened 1 week ago

yakultbottle commented 1 week ago

The save function was entirely not mentioned in the UG. This is a problem as it is not clear whether data is saved at all, and it should be mentioned that there is a dependence on questions loaded into the data folder for the program to run normally.

nus-se-bot commented 1 week ago

Team's Response

Thanks for raising this. We didn't feel it was very necessary but will include in next version.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I respectfully disagree with this issue being classified as NotInScope.

According to the website, the criteria for a UG bug missing features is as below:

image.png

The save function is not "easily discoverable", i.e. the save functionality is not immediately visible to the user during normal operation(there is no message saying "Saving data now"), nor is it intuitive to assume how or when saving occurs (e.g., is it automatic, on exit, or triggered manually?). Similarly, the dependence on preloaded data is not intuitive unless explicitly stated, as users might reasonably assume the program manages its own data loading.

This feature cannot be assumed to be hidden or WIP, as it is central to the program’s operation. Omitting it does not simplify the UG but instead introduces confusion, as users might not know whether data is saved or how to troubleshoot errors related to missing or incorrect data.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I respectfully disagree that the severity is VeryLow. According to the website, severity.VeryLow : A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage. Only cosmetic problems should have this label. However, failing to include features within documentation is not "purely cosmetic", as it could lead to lack of understanding of how to use the product. As such, I stand that the severity is Medium, due to how important the saving feature is to the application.