search

zsoh97 / pe

0 stars 0 forks source link

Repeated figure #15

Open zsoh97 opened 4 years ago

zsoh97 commented 4 years ago

Figure 2 and Figure 5 use the same figure. If it is the same image, you should just refer to the figure number. image.png

nus-pe-bot commented 4 years ago

Team's Response

Thank you for your report.

There are a few reasons we used 2 diagrams here even though they are the same:

  1. They are referred to in different contexts. One as an example of the {Component Name}Manager architecture used in the application, and another as the class diagram for that component itself.
  2. The user does not have to scroll/move to the top/bottom and back to refer to the diagram.
  3. In AB3's DG, a similar presentation is also used, i.e. 2 of the same diagram at different locations in different contexts.

Thus, we believe that this is an acceptable design choice in the DG. We will consider your report as a suggestion for future iterations of the document.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: This issue was raced by my tutor during the DG review given during 2103 tutorial and hence should be a valid issue. Additionally, the documentation of AB3 is lacking and should not be used as a benchmark of what to follow. I believe my reasoning itself is sufficient that they the purpose of labelling a Figure was for referencing and yet, this diagram was repeated when they could have referenced the earlier figure.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]