search

wz27 / pe

0 stars 0 forks source link

Highlighted block about commands that alter the list of students appears several times. #17

Open wz27 opened 3 years ago

wz27 commented 3 years ago

This same highlighted block of text appears 3 times under 3 different commands. It could be much clearer to the reader if the block could at least be tailored to the command section that it is in. For example, the reader is reading about how to use the sort command and encounters this highlighted block, which mentions other commands such as findname and findtag which could be confusing.

image.png

image.png

image.png

nus-se-script commented 3 years ago

Team's Response

We put it this way so that users know what other commands result in a change for both the Students and Classes tab so that the user will not be confused in the future when trying out these commands. By tailoring it to that specific command, we are potentially introducing more confusion to the reader when he realises that those commands result in a change for both the Students and Classes tab as well. After encountering it multiple times, he might wonder "what other commands have this behaviour?" and he would be left without an answer. This way, we are introducing more information without any loss to the reader.

I don't see how a user will be confused when seeing other commands. If anything, this provides them an opportunity to learn about similar commands by searching them up in the user guide.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The same highlighted section of text containing details of all commands that exhibit this behavior is already present at the start of the UG, under Features. Readers can refer to there to identify other commands that exhibit this behavior - they would not be 'left without an answer'. In this case, the highlighted section of text is simply repetitive and is not tailored to the command that it is present under. Readers have the opportunity to learn about similar commands by reading the Features and Command summary of the UG; they should not be distracted by other commands that have similar behavior but is not directly linked to the command in question.