ryantzr1 / pe

0 stars 0 forks source link

No description of what is an invalid edit #9

Open ryantzr1 opened 10 months ago

ryantzr1 commented 10 months ago

Screenshot 2023-11-17 at 5.31.41 PM.png

As an advanced user, I am unable to tell what is an invalid edit. This is a serious problem as I have struggled to figure out what is the correct way to edit the data file.

nus-se-script commented 10 months ago

Team's Response

I understand that it can be challenging to discern valid edits.

As advanced users like yourself, you can seamlessly follow the format of existing data stored in the data file to make logical edits. The sample data that the app starts with serves this purpose well as it contains both tutors and schedules and illustrates the association between the two in the data file.

TutorConnect warns users who intend to use this feature to be careful and sure of the changes they would like to make before proceeding and always make a backup.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Hi team,

I appreciate your response and the guidance provided. However, I must respectfully disagree with the rejection of the issue and the classification of its severity as very low.

As an advanced user, I have found the process of editing the data file to be particularly challenging and confusing. This difficulty stems from a few key areas:

Lack of Clear Documentation: While the sample data is helpful, it does not adequately cover the breadth of scenarios and complexities I encountered. Comprehensive documentation, detailing the structure, acceptable values, and associations within the data file, is essential for effective and error-free editing.

Complexity of Data Structure: The association between tutors and schedules, though illustrated in the sample data, can be intricate and is not intuitively understandable. This complexity is compounded by the lack of detailed guidance on how to handle various editing scenarios.

Risk of Errors: The current system relies heavily on the user's ability to intuitively understand the correct format for edits. This approach increases the risk of errors, especially for less straightforward edits.

Given these points, I believe the issue warrants a higher severity rating. Proper documentation and user guidance are critical for advanced users to confidently and correctly use the editing feature, ensuring the integrity and reliability of the data.


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Hi team, I appreciate your response and the guidance provided. However, I must respectfully disagree with the rejection of the issue and the classification of its severity as very low. As an advanced user, I have found the process of editing the data file to be particularly challenging and confusing. This difficulty stems from a few key areas: Lack of Clear Documentation: While the sample data is helpful, it does not adequately cover the breadth of scenarios and complexities I encountered. Comprehensive documentation, detailing the structure, acceptable values, and associations within the data file, is essential for effective and error-free editing. Complexity of Data Structure: The association between tutors and schedules, though illustrated in the sample data, can be intricate and is not intuitively understandable. This complexity is compounded by the lack of detailed guidance on how to handle various editing scenarios. Risk of Errors: The current system relies heavily on the user's ability to intuitively understand the correct format for edits. This approach increases the risk of errors, especially for less straightforward edits. Given these points, I believe the issue warrants a higher severity rating. Proper documentation and user guidance are critical for advanced users to confidently and correctly use the editing feature, ensuring the integrity and reliability of the data.