Shauryan123 / pe

0 stars 0 forks source link

Not enough visuals for commands: edit, add-skill, delete-skill, etc #23

Open Shauryan123 opened 5 months ago

Shauryan123 commented 5 months ago

Screenshot 2024-04-19 at 5.23.21 PM.png

There are no pictures here to show how the command looks like in the UI with the corresoponding output and therefore is too wordy

nus-se-bot commented 5 months ago

Team's Response

Thank you for your suggestion. However, the length of the explanation in the user guide is already very minimal compared to the complexity of the app and the number of features.

Considering the current user guide is highly understandable, adding more illustrations to the user guide would be of a low priority. Thus we will be marking this bug as "Not in scope" with low severity.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: I disagree with the development team's decision to classify this issue as "Not in Scope" and to mark it with low severity. The lack of visual aids in the user guide for commands such as edit, add-skill, and delete-skill significantly hinders the user’s ability to quickly and effectively understand how these commands affect the UI and what their expected outputs are. Visual examples are integral to reducing cognitive load, particularly for users who are visual learners or those new to the application, by providing clear, immediate references for command execution and outcomes.

The cs2103T website guidelines clearly state that any aspect of documentation that requires the reader to exert more effort than necessary to understand the content can be considered as hindering the reader. This includes the absence of sufficient visual aids in documentation, which is not just a cosmetic issue but affects the overall comprehensibility and usability of the guide. Therefore, this issue should be considered a documentation bug that needs addressing to enhance user understanding and ease of use.


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