nus-se-bot
commented
1 year ago Team's Response
Thank you for raising this issue.
"The yellow boxes should not have a folded corner." - The reason why they have folded corner is because they are notes (default representation for notes is yellow box with folded corner), and the different color of the folded corner box from the other boxes should make that even clearer to the readers.
"If those are notes, they should not be a part of the sequence diagram." - Since the creation of note boxes in UML diagram is not covered in CS2113, the team has searched online for existing methodologies for including note boxes into our UML diagram, and many of them do directly include the note boxes in their diagram (see below). We agree that it may cause some initial confusion for people never seen it before, but given the lack of a commonly agreed upon format for including notes in UML diagram and the fact that many developers do use our method in their UML creation, we do not believe it is fair to flag this format of note taking as a documentation bug.
"This may confuse other developers who may mistake the rectangles with folded corners as paths." - The yellow box with folded corner is a common representation for note boxes in UML diagram, thus we do not believe there is a reasonable chance of it being confused with the representation of optional paths nor alternative paths.
Example of UML note-taking in the developer community
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: We were taught in tutorial classes to only follow the format CS2113 teaches. E.g. no symbols beside class names.
Wrong use of sequence diagram boxes. The yellow boxes should not have a folded corner. If those are notes, they should not be a part of the sequence diagram. This may confuse other developers who may mistake the rectangles with folded corners as paths.
see: optional paths, alternative paths