waynezsy / pe

0 stars 0 forks source link

No UG documentation on editing data #4

Open waynezsy opened 1 year ago

waynezsy commented 1 year ago

There is no mention in UG on how to edit data and some basic expected behaviours (eg if the format is invalid, the app will wipe all data).

I think it is important for this documentation to be present, since it is an explicit project constraint (and hence a NFR) that the data file of the product is to be editable. By not mentioning this anywhere in the UG, users may not find out about this feature, and importantly will not know what are the dangers of this feature (i.e. file wipes). This will affect the usage of advanced users.

nus-pe-bot commented 1 year ago

Team's Response

We do not want our users to mess with the JSON files as our target users are financial advisors who may not be particularly tech savvy people.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Given below is a screenshot of 2103 tP requirement: image.png

A functionality explicitly needed to be supported by the product as part of the requirements is the ability to edit the data file. This is quite a big functionality that cannot be inferred from your current UG due to the absolute lack of mention within your UG. I understand that you may be hesitant to leave it within your UG for CS2101 submission, but for CS2103T, I believe at least a cursory mention of this feature is mandatory as part of your ability to document more difficult features.

Furthermore, "advanced users" suggests a certain level of "know-how" in terms of certain skillsets, such as tech savviness. By not documenting this functionality, you are depriving your users of this category from properly using your feature of editing data files.

The next image is taken from 2103 on UG Deliverable requirements:

image.png