yisiox / pe

0 stars 0 forks source link

Difficult to understand diagram under add team implementation section of DG #11

Open yisiox opened 5 months ago

yisiox commented 5 months ago

This is the same issue as that of the delete implementation. The activation bar notation is not clear if it is accurate, it is difficult to read and hinders the reader.

image.png

nus-pe-script commented 5 months ago

Team's Response

Unfortunately, the DG has a size constraint on the images, thus large diagrams may be difficult to read.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I apologize if the original two bug reports were not clear, but on top of the small font, I am referring to the section on the bottom right as well:

image.png

I presume the activation bars are not intended to be as such, and there are an odd number of arrows, so it seems that there is a return value missing. Moreover it is also unclear what p refers to.

This can possibly be made more readable using the ref syntax of sequence diagrams, or through the use of fictitious methods encapsulating lengthy processes.

The reader reasonably requires much effort to understand the true mechanism of action, and coupled with the course guidelines on credibility of the diagram, I believe the original assessment of Medium is correct.