search

chengseong / pe

0 stars 0 forks source link

Hidden function mentioned in developer guide but not in user guide #18

Open chengseong opened 2 years ago

chengseong commented 2 years ago

Developer guide mentions the functions note and clearnote, however this function is not mentioned anywhere in the User Guide.

image.png

nus-pe-bot commented 2 years ago

Team's Response

We agree that it should be in the user guide.

However, this does not hinder the user. When you open Notor for the first time, the note command is in the welcome message. Not being able to automatically clear note is not a significant hinderance as you could manually delete all text (via command-A then delete as in most text editors).

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: Looking at the welcome message, it is not immediately obvious that the note command is there, and it just looks like a footnote at the bottom of the list of commands that the user should take note of and is easily missed, especially since there is no mention of it in the user guide.

image.png

Even though this does not hinder the user, it is still a documentation error that affects the user's usage of the application.