iynixil / pe

0 stars 0 forks source link

Inaccuracy in `FAQ` of UG #5

Open iynixil opened 7 months ago

iynixil commented 7 months ago

Screenshot (if any): image.png

Rationale (includes explanation of severity): For the one question in the FAQ section of the User Guide, the answer to it states overwrite the empty data file, but this is inaccurate as the data file is not initially empty when the app is run for the first time. This is assuming the answer to the question implies that the app has to be run at least once after installation to generate any data files, but it would also be good to explicitly state this assumption. (Medium considering that transferring data may not be a rare occurrence)

Recommendation/Suggestion: Edit the answer to say overwrite the data file(s) it creates or give an appropriate answer.

soc-pe-bot commented 7 months ago

Team's Response

This was the same phrasing given by the AB3 User Guide and they had similar systems with regards to the data file, changed to low as it is a minor inconvenience and there are ways to go around this (clear command)

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: I understand that the phrasing may not have been modified when adapting this from the AB3 UG. However, bugs inherited from AB3 may still be considered bugs: image.png The bug lies in the inaccurate phrasing of empty data file, where even in AB3, it was also not "empty" and could have also been wrong to state as such. (this is still assuming the same assumption in the original bug report that the app is to be run at least once after installation)

I disagree with the workaround/severity, as this is part of the FAQ section, meaning it may not be a rare occurrence to want to transfer data, and the workaround given (using clear), which clears all data, may not match the purpose of transferring existing data.