search

Jarrod-Bob / pe

0 stars 0 forks source link

Inconsistencies in the Command Formats in the UG #10

Open Jarrod-Bob opened 4 years ago

Jarrod-Bob commented 4 years ago

There is no Command Format being written for import transactions when it does involve a parameter to the command.

image.png

I understand if you choose not to input the command format for commands which only involve the command itself, like clearrecurring or clear, but for a command such as import which involves a format, I feel like as a user it would be clearer if I knew what the format was rather than having to infer it.

But then again, there are inconsistencies even for the single word commands with no input parameters. Some choose to show the format, while others have chosen not to. This might hinder the user who looks for uniformity in the usage of this UserGuide. An example is shown as below:

image.png

nus-pe-bot commented 4 years ago

Team's Response

This flaw is cosmetic and does not hinder the usage of the application.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: It is not purely cosmetic as it might impede the user's usage of this application. Things like the Clear Command does not even have an exmaple to refer to. How would I know if clear is just like the other single word command like exit in that it does not require any parameters?

What if I did clear data instead thinking that it could be used like the other commands with parameters?

Documentation bugs technically don't affect functionality of the application at all since it is all purely words, but indirectly it could affect the usability of the application.

Upon second consideration, I am thinking at worst a severity.LOW.