search

Silvernitro / pe

0 stars 0 forks source link

UG: Misleading title for `show` command #7

Open Silvernitro opened 3 years ago

Silvernitro commented 3 years ago

The title for the show command in the UG says "SideBar" components, but in actuality it refers to just the "tags" component, which is promptly explained in the description. Maybe it'll be good to just say "tags" component in the feature title

nus-se-bot commented 3 years ago

Team's Response

We are planning to include other side bar components under this feature. We think it will be more confusing for users in the future if we were to change the title of this section.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I think that titles in the UG should always accurately reflect the current behavior of the app. I believe it is more confusing to tell a user that they can toggle side bar components in the title when in fact, only one particular side bar component can be toggled.

Also, when more side bar components are added to the feature in the future, I don't see why changing the title will be confusing. Instead, I feel that it clearly highlights to old users that the app now supports more components.

On top of this, the team's argument about confusing "users in the future" seems to be based on the assumption that an existing user will be confused by the discrepency between reading an old UG vs a new one. I'm not sure if this is really valid as UG readers tend to be new users who are trying to learn. As such, they won't be aware of any title changes since it will be their first time reading the "new title".

That being said, I do agree with the lowering of the severity.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]