search

bnjmnt4n / pe

1 stars 0 forks source link

User guide: Parameters section is overwhelming #8

Open bnjmnt4n opened 3 years ago

bnjmnt4n commented 3 years ago

Immediately after describing the command formats, a long list of parameters are displayed. This can be very overwhelming for first-time users, as there is a huge list of information about the fields to parse even before they are fully aware of what commands are available and what fields to use. There is also a column called "Application field", which is confusing since it has not been defined, and the user does not know yet that there are different kinds of commands, which do not deal with editing application data.

There should have been a brief description of what an application contains, perhaps along with the GUI, so the user is at least aware what application fields are available. Instead of listing the parameters in alphabetical order, they could also perhaps be split into application fields and non-application fields to add a clearer distinction.

nus-pe-bot commented 3 years ago

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