search

xxzz-tt / pe

0 stars 0 forks source link

Template description can be clearer #11

Open xxzz-tt opened 3 years ago

xxzz-tt commented 3 years ago

I think it would be better and useful to explain what a template is to the user as I was really confused about this feature when I first saw it. I only had a rough idea after reading the create and addt commands instructions a few times.

Screenshot 2020-11-13 at 5.31.28 PM.png

nus-se-bot commented 3 years ago

Team's Response

We thought the template creation was quite intuitive as this comand is simply used to create the templates. The usage of the template is explained in the addt command.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Though the command format is straightforward, it should not be up to the users to guess what a template is and how it is used for. It is also important for users to understand the purpose of a template when they first see the term so that they can start using the feature appropriately and do not need to constantly refer to other sections to understand what it entails. Also, the addt command did not really explain what a template is and only provided examples of its usage for users to infer. Without the explanation, there will be occasional inconveniences to the users who want to use this feature as they cannot use the feature readily and have to keep scrolling through the UG to find further elaboration and try guessing and inferring its actual usage. Furthermore, as the template is a relatively unique feature of the team, it is not reasonable to assume it is intuitive for users to understand its function.