kinjalagarwal1810 / pe

0 stars 0 forks source link

Purpose of the showrelated function #18

Open kinjalagarwal1810 opened 6 months ago

kinjalagarwal1810 commented 6 months ago

image.png

The purpose of the above mentioned functions is not clarified. I feel like you could have specified why this function isnecessary for ur target user so as the make it more meaningful this will also help to explain how ur product is suited for the target group you decided.

I feel like instead of this function you could have perhaps used the UI to show the relations as another field or tag or other features. This seems like a very long winded way to find the relations.

nus-se-script commented 6 months ago

Team's Response

This function is an extension of the relate command (which is above itself in the UG). We decided not to use UI /another field etc. to show the related profiles because it is not scalable.

For example, if you have 1 employee that is related to 100 suppliers, we can

Hence, we believe that this way is the optimal solution to get a clear view of the related profiles and navigate between them seamlessly without distractions.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for your response, I understand where you are coming from. I noted this as a documentation bug, I am not denying your choices, it may have been the most useful option, but since it was not stated in the UG, readers would not understand your perspective.

Regarding the purpose of the command, the short phrase you used to describe it is not enough to encapsulate the purpose, benefit/reason for this feature. Which is what makes me confused about you decision for this feature, not using the UI to show it etc. Because the purpose of the feature is not stated in the UG, as a potential user of your product I cant imagine a scenario where i would need to use this command.

The above explanation is considering there is a good purpose of the feature that you simply did not mention. However, since it is not included I do not think this command is necessary in the first place. Yes, a UI might cut off the relations if there are too many, however did you consider other options like a separate section on your GUI. You can have your main page which is the format of ab3 and add a new right section where if you click on the person you can see all the relations they have on the right side in the format of a list or other formats.

This is just a suggestion I think overall, everything just needs to be explained better so as a reader i don't question your choices and ask "why didn't you do this though?"


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** If the explanation for the command is not clear it will cause an issue for many readers as they do not understand its purpose.