search

CJerrong / pe

0 stars 0 forks source link

Diagram overly complicated in the DG #14

Open CJerrong opened 2 months ago

CJerrong commented 2 months ago

image.png Can be challenging to read the text in the diagram due to the complexity in the diagram. Could hinder developers attempting to read the documentation and trying to understand the inner workings of the application.

nus-pe-bot commented 2 months ago

Team's Response

Thank you for the feedback but we did not include any lower-level details in this diagram and all commands shown are necessary.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Although I do agree that all commands shown are necessary, the team could have perhaps created separate diagrams, to make the diagram more legible. This is a valid concern that could hinder the reader when reading the documentation, and should thus be a VeryLow documentation bug.

Nonetheless I recognise that this issue may be of less importance compared to other refinements done in V1.4 and may be considered as NotInScope.