yongmingyang / pe

0 stars 0 forks source link

Inconsistency in UserGuide, page 13/34 #9

Open yongmingyang opened 3 years ago

yongmingyang commented 3 years ago

I refer to this portion of page 13/34

image.png

I find that this portion is inconsistent with the other description of the commands as none of the others show an error case as seen in the image. I feel that this portion add unnecessary clutter to the add command. Instead of placing an example on the error message here, the error message could be shown in the GUI, roughly stating something similar such as:

"you can only change max quantity by the edit command, not when adding".

This would make the add command more consistent with the others in the UG

nus-se-bot commented 3 years ago

Team's Response

It is unclear what the tester is trying to say hence we will give our replies based on possible interpretations:

Screenshot does not need to be there: As add is the first feature in our UG, putting a screenshot helps to orientate the user where it can be found. Afterwards, it is omitted so that there is less repitition as we assume that user already knows where can they find the error message.

Different error message: Our error message already captures the issue and tells the user what can or cannot be done using add-i command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.IssueUnclear]

Reason for disagreement: Thank you for trying to clarify. My intention was that this particular screenshot need not be there. This is because I felt that when using the app, the area where the error occurs is self evident. Secondly, this screen shot was made in the context of the add command, and not on the User Interface. This means that the screenshot was shown as an example for errors in the add command, rather than trying to orientate the user on where to find the error message.

In summary, my intention was that the screenshot was unnescesarry and it only made reading the add command more confusing in my experience, rather than helping me to understand how the add command is used.