search

nus-cs2103-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Information hard to understand #1096

Open nus-se-bot opened 3 years ago

nus-se-bot commented 3 years ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Certain commands require users to add in time zones and 2-letter country codes, some of which users might not be well aware of. The lists/tools to help the users are only shown in the paramter constraints summary, after an extensive search. Should be included in explanations so that users are informed.

List/tools:

image.png

[original: nus-cs2103-AY2021S1/pe-interim#999]

qwoprocks commented 3 years ago

Team's Response

Thank you for the bug report! Right after the quickstart section of our User Guide, we added the disclaimer that "Certain commands require parameters ... their prefixes and constraints can be found in our parameters summary table." (Refer to screenshot below).

image.png

We also expressed the intended format by providing examples under every command in our User Guide, and if a user enters a command wrongly in our application, error messages are displayed that guide them back onto the correct path. For examples, please refer to the screenshots below:

image.png

image.png

We felt that this was sufficient information for users to use the application effectively, especially since our target users are businessmen who travel frequently. Thus, it was an intentional design choice on our part to have this information only in select places in the User Guide, so as to not clog it up.

We changed the severity to Low as this is a rare issue that shouldn't affect most readers as we have stated it in our introduction to TBM's features.

Duplicate status (if any):

--