Benjamin-Sim / pe

0 stars 0 forks source link

Product does not allow users to manually edit data file #4

Open Benjamin-Sim opened 1 year ago

Benjamin-Sim commented 1 year ago

As stated in the project constraints, the data file should be human-editable. However, based on the user guide, the product does not seem to support editing the data file directly.

This is a bug as the new product should at least have the same level of support for manually editing the data file as AB3.

image.png

nus-pe-bot commented 1 year ago

Team's Response

Our app does in fact use JSON, which is a human-editable file. However, in our user guide was framed this way because we want to prevent the user from getting into unwanted bugs.

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It's good to frame the user guide in a way that will reduce the chances of the user making errors. However, I still think the option to edit the data file should be presented to the user.

The line "Do not edit the json files on your own!" suggests that the product is incapable of handling manual edits to the data file, which appears to violate the project constraints. However from your explanation, it seems that the product is indeed capable of handling manual edits but it is something the dev team discourages users from doing.

If that is case, I think the user guide should have been phrased in a way that highlights this nuance: That manual edits are possible but discouraged. This is a more accurate description than outrightly telling the user not to edit the data files.

As such, I think this issue should be changed to a documentation bug instead of a feature flaw, with a low severity.