rohit0718 / pe

0 stars 0 forks source link

Difficulty in maintainig UG due to nature of commands #21

Open rohit0718 opened 2 years ago

rohit0718 commented 2 years ago

In its current state, the following examples in the command summary table will not work past the given dates. If a user were to use the app next year, they may be confused that the provided command do not work as the given dates lie before their current date.

image.png

Same thing goes for all examples provided for the dates in the payment by/ and receive/ methods throughout the UG. This leads to a UG which needs to be constantly updated, making it difficult to maintain.

nus-pe-bot commented 2 years ago

Team's Response

If a user were to use the app next year, they may be confused that the provided command do not work as the given dates lie before their current date.

There is no date in the future that will work forever, i.e the date 01-01-5022 would also be invalid when it reaches that time.

As this is a command summary where we wanted to provide a legitimate example command, we had the option to either:

  1. Omit an example for this command which would cause confusion among users
  2. Put a realistic example that may become invalid in the future if we do not update our User Guide timely

For this iteration, we chose the latter as it provides greater clarity for our testers and users of the application.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: "There is no date in the future that will work forever". I agree with this, but I feel that this should have been explicitly stated in the User Guide. A small note about this in notes about commands might prevent future confusion over commands that fail to run.

At its current state, if a user were to use the application with reference to the User Guide in just two months time, the commands in the quick start guide will not work. A short note about this would be very helpful!