Yvorm / pe

0 stars 0 forks source link

Seqence Diagrams are excessively scaled/high-level #6

Open Yvorm opened 2 weeks ago

Yvorm commented 2 weeks ago

image.png

image.png

While most sequence diagrams are comprehensive and appear accurate, it would benefit readability significantly to split the functionality covered by the largest high-level sequence diagrams into stages, and have seperate diagrams expand upon each part. (i.e. splitting the initialisation into memory retreival/user input parsing).

Currently at the scale neccesary to capture all details, these larger graphs can be laborious to read, as users must specifically zoom in to read any name/description, and must find the specific functionality (out of the multiple covered in a single sequence diagram) to observe.

nus-se-bot commented 1 week ago

Team's Response

Hi Tester, Thank you for your Description of Issue and Feedback.

while we can understand your point of view,

this is ultimately subjective, and different users/readers may have different opinion.

nothing wrong about zooming in. As long as the diagram pictures are not low resolution.

some readers may prefer one unified diagram.

Also, for the Sequence Diagram(s) for the execution of “add” command , we have split into two diagrams instead of one diagram.

For future iterations, we can consider splitting the diagrams into individual functionalities.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]