evanyan13 / pe

0 stars 0 forks source link

[UG] Unclear instruction for what are compulsory fields #7

Open evanyan13 opened 10 months ago

evanyan13 commented 10 months ago

It is mentioned in the UG that All the compulsory fields must be provided. for the add command. However, there seems that what is considered compulsory fields is not explicitly mentioned in the UG

Screenshot 2023-11-17 at 5.17.24 PM.png

I encountered trouble testing the add command as I was entering the format of add n/NAME id/ID

When I click the line All the compulsory fields must be provided., it leads me to this section which does not explain to the reader what is a compulsory field

Screenshot 2023-11-17 at 5.22.59 PM.png

It was only later that I found out after scanning through the UG more in-depth that the team has included this specification elsewhere in the Glossary.

Screenshot 2023-11-17 at 5.24.44 PM.png

Thinking from the reader's perspective, I think it would be better if the hyperlinks could be more intuitive and direct the readers to what they want answers for.

Severity Check

nus-se-script commented 10 months ago

Your response not required for this bug as the team has accepted the bug as it is.