jwdavis0200 / pe

0 stars 0 forks source link

Cluttered UG by compiling features into one section. #11

Open jwdavis0200 opened 2 years ago

jwdavis0200 commented 2 years ago

image.png

Features are not categorised and results in a long intimidating list of features that will grow even longer and more cluttered in the future. Hard for user to find specifically which feature they want to learn about by categories of removing or adding for example.

nus-pe-bot commented 1 year ago

Team's Response

The purpose of the feature navigation is to allow the user the user to navigate to specific commands in the UG. Moreover, we do not see a cosmetic issue as it is rather concise.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree with the team's response. Clearly the table of content given lacks the organisation that a User Guide should have.

This formatting of the User Guide toc has two disadvantages among others:

  1. The UG is not categorised into types of commands such as, categorising them into sort commands, select commands, delete commands etc. This gets really messy especially as iterations goes by and more features are added into the application. Imagine going through each point finding the exact command you would like to learn about as a new user. It can be rather daunting to see such a long list(without proper categorisation).

  2. The toc is not even in alphabetical order or any form of discernible pattern for the user. Perhaps this was why during the testing, I felt that it was hard for me to find the exact command I wanted from the list of features. Now imagine when the feature lists get longer.

This is detrimental to the quality of the UG, mainly not so much on just the cosmetic part of the UG.


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: image.png

The format of this toc will hinder new users when they try to find the specific new commands they are trying to pick up to use the features of the app. As shown by the definitions above, this fits the severity.low as it causes "minor inconveniences" to the user as they start learning about the app, or when they are unfamiliar with the application. While it affects cosmetically, the main concern is with how user-convenient the UG is for new users.