search

louisjoety / pe

0 stars 0 forks source link

[DG] Notation of the words #15

Open louisjoety opened 1 week ago

louisjoety commented 1 week ago

The notes are being overlapped by the arrows across the DG, while this can be purely cosmetic however it occurs multiple times across the DG, hence the severity will be slightly raised as a result beyond just cosmetics.

image.png

image.png

image.png

image.png

nus-pe-bot commented 1 week ago

Team's Response

This is a PlantUML Diagramming Tool limitation, and according to the course website under "UML notation variations", can be rejected.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: image.png

While it’s true that it is negligible under UML notation variations, the dev team should still acknowledge that these differences can hinder readers' understanding and slow readers (like me) down during the PE due to the obstructions they introduce especially given the short amount of time (30 minutes) to identify documentation bugs. I think it should still be raised to the dev team so that future users will be able to read the documentation much more easily.

Moreover, if the team deems it to be a PlantUML Diagramming Tool limitation, perhaps stating it as a disclaimer in the DG would provide greater clarity. Since the PlantUML Diagramming Tool is not mandatory for all teams, not everyone will be familiar with its limitations. Additionally, during the PE, testers would not have the time to determine whether an issue is due to the tool’s limitations or an actual bug. This would ensure that the limitations are made clear to me so that I am not led to believe that it is a documentation bug since the dev team has acknowledged it before the PE.

Lastly, if the issue lies with PlantUML, switching to another platform could be a simple and effective workaround.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** **_NOTE:_** A low severity is defined as a flaw that is unlikely to affect normal operations of the product. Appears only in very rare situations and causes a minor inconvenience only. While it is indeed a cosmetic flaw concerning the layout of the document and it does not affect the usage of the app, the constant overlapping of the words slowed down my reading and caused misunderstandings several times during the PE as I was trying to look for documentation bugs in that 30 minutes. The interruptions to my reading and train of thought while going through the DG caused me some minor inconvenience, especially since this occurred multiple times during the PE. Therefore, during the PE, I decided to raise the severity level to `severity.Low` from a `severity.VeryLow`, having initially assumed it was just a one-off issue.