search

sdevih / pe

0 stars 0 forks source link

User guide has no glossary section #7

Open sdevih opened 7 months ago

sdevih commented 7 months ago

Description

The user guide glossary does not have a glossary section to explain the different terms used throughout the application. For example,

  1. how is attendance defined? Given that one student can have multiple datetimes, the user does not know to which datetime does attendance refer to. 2, How are grades defined? There is no definition of what grade inputs are accepted. There be be different grade scales used so glossary should define what grade scale is used (A+ to F, or 1 to 7, or 1.0 to 5.0 etc)

This could almost render features like filter (which highly depends on grades) almost unusable

Screenshot

No glossary present in user guide

image.png

nus-se-bot commented 6 months ago

Team's Response

No details provided by team.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

No glossary in the UG

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

There is no glossary in the UG. It would help to clarify terms such as CLI and GUI to the target user, who might not be familiar with these terms.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#559] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

No details provided by team.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** Thank you for your response. While I agree with the classification of the bug as a duplicate to the issue that there is no glossary, I politely disagree with its reduction of severity to veryLow. According to the tP instructions, a bug of severity veryLow is only given to a flaw that is purely cosmetic and does not affect usage such as a typo/spacing/layout/color/font issues in the docs. However, the fact that the entire glossary is missing from the user guide is not a cosmetic issue but rather a largely inconvenient one. As I have previously stated in my original bug report, the lack of definitions of very important terms such as grades and attendance, and what they entail causes occasional to major convenience for users, given that many other features (such as "filter student by grade" feature) greatly depends on what grade scale the application uses. With that said, I do believe that this bug can be of severity medium now, as it does cause occasional inconvenience to some users who would need to know how the key parameters in the application (like grade and attendance) are defined, to utilise the product without hindrance, but they can continue to use the product.