cx0810 / pe

0 stars 0 forks source link

Missing documentation for `prof` and `ta` #14

Open cx0810 opened 3 years ago

cx0810 commented 3 years ago

In the features section, it mentions about special tags prof and ta as shown in the first screenshot. The Modules section under GUI also displays the Professor and TA of the specific module under the second screenshot shown in the user guide.

However, users are not given instructions on how the format of these two tags work and how to display the professor or TA for a module under the GUI.

image.png

image.png

nus-se-bot commented 3 years ago

Team's Response

Prof and TA is the same as normal tag in terms of design, they just illicit a different UI response. This is mentioned in the user guide.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The prof and ta tags are a special form of tag that differs from the normal tags given to contacts since it behaves differently when contacts tagged with prof and ta are added into a module. This differentiation should have been made clearer to users in the user guide instead of just putting it under notes. Users might find it difficult to understand the exact functions of these two tags since there were little information about it in the UG.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]