search

Christopher-LM / pe

0 stars 0 forks source link

The label of the arrows in this sequence diagram seems unnecessarily lengthy #18

Open Christopher-LM opened 4 years ago

Christopher-LM commented 4 years ago

No details provided. Screenshot 2020-11-13 at 1.26.16 PM.png

Would be good to cut down on the label length for each arrow as it makes the diagram seem messy and difficult to follow

nus-se-bot commented 3 years ago

Team's Response

Hi, thank you for your report! : ) We are glad and grateful that you have spent the effort to try out and test our products. We appreciate your effort in trying to help us further polish our product. And after careful consideration and discussion, we decide to lower the severity a bit and accept this problem.

Firstly, we are sorry that we decide to change the severity level to VeryLow. This is because after careful consideration, we found that most of the arrows and words in our origininal diagram(PDF and website) are recognizable and does not affect usage and it is a layout and styling issues in the docs. Thus, according to the website definition on Levels of severity, we decide that it is best fit into VeryLow.

image.png

Secondly, as shown on CS2103 website, "complicated UML diagram" is listed to be the lowest severity in Documentation section, thus, we decide this is a VeryLow severity.

image.png

Thirdly, we have really tried our best to simplify this diagram and pleasee understand us TT. As our add command has all the compulsory attributes of a book, thus our initial diagram of add was even much more complicated haha. However, we still design to represent it as a whole because the whole sequence is continuous and sequential. The sequence diagram is also similar to the ones of other commands. Thus, in order to follow the consistency and flow, we choose to present it as a whole.

After we have created the first version, we found that it was too complicated to have all the attributes. Thus, we tried out best to simplify it and come up with the current version. We have also consulted the prof when creating the diagram, and decide to simplify and omit all attributes except only one (book name). Thus, we have really try to simplify it while still following the consistency and flow in our DG. We think that further simplification may lead to ambiguity, inconsistency, or misunderstanding. TT

With the given the reasons, our team decided to lower the severity a bit. Thank you so much for your response, and our team hopes that you can please understand our decision TT.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your reason]