YHWong20 / pe

0 stars 0 forks source link

Missing diagrams for all components #19

Open YHWong20 opened 2 weeks ago

YHWong20 commented 2 weeks ago

No class diagrams or sequence diagrams.

Everything is crammed into an overall diagram, and this makes the overall diagrams hard to understand and read.

soc-se-bot commented 2 weeks ago

Team's Response

we did made class diagrams for each class , but the diagrams were in /doc and we didn't put it in the DG , so maybe it will be eaiser to understand if we do put those diagrams in DG

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: That's fair, and I do agree that if the individual class diagrams and sequence diagrams were provided in the component sections, it would make the DG easier to understand.

However, I do not agree with the VeryLow severity rating here.

I would believe that this issue is likely to be of a Low severity instead (I recognize that the Medium rating I gave was not too justified either).

The lack of these diagrams will cause an inconvenience for the reader. Even though detailed descriptions are provided in the DG, I would also like to point out that the lack of diagrams will make it difficult for the reader to visualize and understand what exactly they're reading. I believe that the lack of such diagrams can indeed create some hindrance for the reader, as they'll need to continually scroll up to your overall diagrams, and cross-reference what they're reading with the overall diagram.

As this is not a cosmetic issue, VeryLow severity rating doesn't quite make sense here. Thus, I hope you understand why I disagree with the new severity rating.