search

Jnjy / pe

0 stars 0 forks source link

UG: Confusing clustering of status #7

Open Jnjy opened 1 year ago

Jnjy commented 1 year ago

I believe that this is to tell the reader that these are the status that can be used for the upcoming command. However, when placed together in a single code block makes it confusing for the reader, hence possibly hinders the reader's understanding on this command when trying out.

image.png

Suggestion: Can try separate the status instead. For example, NEW / OFFERED / ASSESSMENT / INTERVIEW

soc-se-bot commented 1 year ago

Team's Response

Hello there! Thanks for your input.

Our team believes that this is not a bug because it does not affect the understanding of the explanation. We believe that a user could understand New/Offered/Assessment/Interview in the same way that they can understand New / Offered / Assessment / Interview. As mentioned in CS2130T's website, documentation bugs would cause readers to not understand the content of the guide well. However, this issue would not make understanding harder.

image.png

However, we do agree that for consistency, New / Offered / Assessment / Interview might be better. Hence, we would classify it as follows:

  1. severity.veryLow because it is just a cosmetic issue of deciding to highlight each status separately, or highlight them together.
  2. It does not impact current readability or understanding. Readers can still understand. Therefore, it is a future enhancement/improvement, and we classify it as response.NotInScope.

    Items for the Tester to Verify

    :question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]