winson8222 / pe

0 stars 0 forks source link

Lack of instruction to edit JSON data file in User Guide #9

Open winson8222 opened 10 months ago

winson8222 commented 10 months ago

image.png

Description

There is no instruction to teach advanced user how to edit the file in the json data file.

Reason for severity

It is medium as based on the project constraints the file should be able to be edited. However, without proper instruction on how to edit it properly, all data will be discard on next run. This can lead to great consequence especially if no other record are kept of the current prescription list.

nus-se-script commented 10 months ago

Team's Response

Not in scope.

By stating that advanced users are welcome to edit the file, they should and would already be familiar about the constraints of JSON and data types to be considered advanced.

We felt that there need not be an explicit guide to teach them how to manipulate the data file, as that is not the main way users should be interacting with the app, nor is it the aim of the UG.

If they are not advanced and do not know how to, they should refrain from editing the file. We aim for the UG to teach users how to use the product, which on its own can already save and manipulate the data.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: One of the constraints of the project is to have Human editable file. Given the severe consequence of a corrupted file and absence of the definition of an advance user in the UG., I feel that this is should not be considered not in scope as with the definition of not in scope, there should be specific handling for the case when the file is corrupted the feature being included in future enhancement but there is not currently.

image.png


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]