nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Help menu can be improved #3279

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Prerequisites: None

Command to execute: help

Result: image.png The result is a link to the User Guide, however what if the user does not have access to the internet but still wants to carry out operations?

Suggestion: Display the feature section of the User Guide or the Command Summary as the Help Window instead for an easy access way to provide help to the user.


[original: nus-cs2103-AY2425S1/pe-interim#2165] [original labels: type.FeatureFlaw severity.Low]

hj235 commented 6 days ago

Team's Response

Hi, thanks so much for the input! After thorough discussion, we feel that your suggestion, while perhaps valid in unlikely circumstances, would be unreasonable to accomplish. We feel that a document as detailed and lengthy as the features section of our user guide would not be well-suited to be displayed within the JavaFX application, as it would not be as comprehensible and could cause further confusion. It would be more appropriate to direct the user towards a more readable medium, as in a website or separate document on its own.

Furthermore, it is highly unlikely that the user's lack of access to the user guide would be a serious problem, since the user would require internet access to install the application in the first place, and during the process they would likely have come across the quick start section of the user guide, and be able to read the rest of the document.

Duplicate status (if any):

--