MatthiasLHK / pe

0 stars 0 forks source link

Similar Component color for State and Storage. #26

Open MatthiasLHK opened 4 years ago

MatthiasLHK commented 4 years ago

The component color used to represent the State and Storage are extremely similar, which was confusing as the readers, me, thought that you have implemented them as a single component, which is not the case. I think you could have choosen another color to represent one of the mentioned components to better differentitate them.

image.png

image.png

nus-se-bot commented 4 years ago

Team's Response

We will try to make it more distinct. However, we believe the aesthetic aspects of the DG should not be counted as a bug.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Hi, thank you for your response but I diagree. This is not considered to be an aesthetic issue. As the reason for the color coding of components is to group certain classes under the same component, hence it is used to make the DG and the UML more understanable and readible. In this case, you did not use the color for aesthetic purpose, if so, then this is not correct as well. Also, this reflects the amount of effort you put into the documentation as this issue can easily be fixed by simply assigning a different colour to the component in the UML file. The reason why this affects the user as the user may misinterpret that State and Storage are under the same component, which may lead to further snowballing of misunderstanding.

As you can see here,

image.png

it is stated the even cosmetic issue are considered as bugs and are set as very low, however, in this case, it will actually affect the user and cause inconvenience to the user, which falls under the severity of medium.

image.png

Hence, this is considered to be a documentation issue. Hope this clear things up. Thank you!