search

zhuuyicheng / pe

0 stars 0 forks source link

Saving data section incomplete in DG #16

Open zhuuyicheng opened 6 months ago

zhuuyicheng commented 6 months ago

image.png

It seems that the "saving data" section in the DG is incomplete, as it describes what should be done instead of the actual implementation or future plans for it.

In the event that users encounter an issue with corrupted files, they will not be able to solve the issue. Medium severity as most users will probably not encounter file corruption issues but in the event that they do, it is very difficult for them to fix it.

nus-se-bot commented 5 months ago

Team's Response

The section was not worked on, and is definitely missing in the DG but it does not necessary cause the readers to be too confused or inconvenienced.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: In the event of data corruption, this incomplete section will lead to more than just a minor inconvenience as in the worst case scenario, the users' data gets completely removed and is unable to do anything about it. This can severely impact their saved data, so documentation for reliable methods for recovery or mitigation plays a crucial role.