soc-se-bot
commented
10 months ago Team's Response
In order to change the game state via the storage file, one needs to edit the final chessboard state (next 8 lines after the moves lines) apart from the moves
However, we do accept that the user guide was not updated with the exact details of how to edit the saved file so this is a duplicate with #368
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Lack of detail in UG regarding editing save file
Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.
The user guide expressed that users are able to edit the save file directly to achieve a desired game state, showing only 4 out of 6 components in the save file.
There was no explanation for the remaining 2 purpose, so the user can only assume that changes to the shown 4 variables are sufficient. However, making changes to 1 piece location caused the file to not be recognised
Original Left, Edited Right. This suggests that there might be other factors for determining game state, which is not explained in the User Guide.
Since this editing feature is explicitly mentioned in the User Guide, it is safe to assume that average users will attempt to use this feature. However, being unable to utilize it would warrant a MEDIUM severity as it will likely affect all users who attempt this.
[original: nus-cs2113-AY2324S1/pe-interim#296] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
No details provided by team.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [x] I disagree
Reason for disagreement: I do not think that they are duplicates as they are different in their focus. The 'Original' problem revolved around insufficient documentation regarding save file usage, while this current issue concerns the error handling process within the application. The critical aspect here is the application's approach to errors. It fails to guide users and instead, immediately deletes the save file without providing any assistance.
A more user-friendly and effective implementation would involve the application notifying the user when discrepancies are detected between the saved moves and the current chessboard state. Rather than outright deletion, prompting users about these inconsistencies would not only prevent unintentional loss of data but also empower users to reconcile the differences. This approach aligns with a more considerate and supportive user experience, as well as the intention behind the feature.
## :question: Issue type Team chose [`type.DocumentationBug`] Originally [`type.FunctionalityBug`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
The only text changed in this save file was the highlighted portion. Initial value was d2 c1. As the piece was a bishop, changing it to d2 e3 is a valid move. However, the application does not see this as a proper game file. This goes against what is stated in their User guide: "Users are welcome to update data directly by editing this data file to achieve a desired game state."