weiliann / pe

0 stars 0 forks source link

Inaccurate quick start information in the user guide #1

Open weiliann opened 1 week ago

weiliann commented 1 week ago

Issue: Incorrect application name in the user guide.

The user guide suggests to run the application with the command java -jar tutorease.jar. However the actual application's name is called CS2103-F11-2-TutorEase.

As a new user I am completely lost and unable to use the program since i do not know how to start the app. this causes a significant amount of inconvenience and disruption for new users trying to use the app. This warrants a medium severity since the application becomes completely unusable for beginner users relying on the user guide for accurate information to start the app. Copying the exact command given in the user guide will not work and they might give up on the application hence it might even warrant a high severity since it becomes unusable for most users. I believe a medium severity will allow us to reach a consensus and work together to improve the application.

From User guide Quick start: image.png

Actual product name:

image.png

soc-se-bot commented 1 week ago

Team's Response

Thank you for raising this concern. However, if you were to follow the quick start steps individually, you would realize that you should have downloaded the file from the Release Notes for it to be named as tutorease.jar.

This is an exception as we are all required to download from the dropbox, and would not pose any problems to the general users who will download from the Source.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]