Bandov / pe

0 stars 0 forks source link

UG issue which prevented the opening of jar file #2

Open Bandov opened 5 months ago

Bandov commented 5 months ago

Documentation Bug (Severity MEDIUM)

Steps to reproduce

  1. Using this command directly from the UG doesnt actually work due to the special characters in the file name. Screenshot 2024-04-19 at 4.20.01 PM.png

Expected For the jar file to be open.

Actual Screenshot 2024-04-19 at 4.21.09 PM.png This is instead returned.

This is severity medium as a user that is not taking 2103 would not know of the issue with the special characters and needing to use the "" to wrap the name.

nus-pe-script commented 5 months ago

Team's Response

Inherently, there is nothing wrong with this jar command. It indeed works, barring some exceptions from some terminals. It is convention to surround the jar file with quotation marks as a safe guard when opening jar files if you are already aware that your os faces this issue. This is also emphasised as a tip by the profs, as shown in the screenshot below. Furthermore, because this is an OS specific issue, only experienced by some terminals, we believe it is out of scope.

telegram-cloud-photo-size-5-6138804929951809359-y.jpg /var/folders/tg/yrcwyrrj2_qc1tf0swypgctw0000gn/T/ru.keepcoder.Telegram/telegram-cloud-photo-size-5-6138804929951809359-y.jpg

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Early technical issues, like errors from following official documentation, can significantly deter new users. A troublesome start undermines user confidence, suggesting complexity and unreliability, potentially leading to a steep perceived learning curve. This initial barrier may result in a loss of interest, especially among less tech-savvy users, who might opt for alternatives rather than navigate unexpected troubleshooting. **Accessibility and User Friendliness**: Documentation is often the first interaction a user has with an application, and if the **instructions provided don't work as described for a standard setup**, it can be a **significant barrier to entry**. Users **unfamiliar with the intricacies of command-line interfaces** such as those that are the expected users for the app, may not be aware of the need for quotation marks around filenames with special characters. **Expectation of Accuracy**: Users expect the documentation to provide **accurate commands that work** without **additional modification**. When the **instructions fail without a clear explanation or forewarning**, it undermines the user's trust and can be considered a major issue because it directly prevents the use of the application. **Consistency Across Environments:** While the issue might be OS-specific, **documentation should account for common environments** where the software will be run. If it's known that **some operating systems interpret special characters** in a way that requires additional syntax (like quotation marks), the **documentation should reflect that** to ensure a smooth user experience across all supported platforms. **First-Time User Experience**: A **first-time user**, or one unfamiliar with the terminal's nuances, may be completely stalled by this issue, which **could lead them to abandon the application** altogether if they can't get it to run. In summary, providing a command in the user guide that doesn't work out-of-the-box for users due to special characters in filenames can be seen as a major bug. It directly affects the application's usability and accessibility, particularly for those who are not computer science students or who are not well-versed in command-line intricacies.