search

bharathcs / pe

0 stars 0 forks source link

No mention of the "Progress Chart" in `Ui` (DG) #12

Open bharathcs opened 2 years ago

bharathcs commented 2 years ago

The progress chart component (the pie chart, heading and enclosing container) is not indicated in the Ui partial class diagram. While it is admitted as partial, I do believe such a significant part of the user's user interface (really striking & takes up lots of screen area, and commonly used) should be well explained. It is missing from the DG.

In fact there should be thorough explanation of how it refreshes, where it is situated in the architecture etc. This is a major missing parts that are critical to any future developer working on the frontend.

image.png

nus-pe-bot commented 2 years ago

Team's Response

This does not make the Developer Guide unusable by readers. However, it might cause occasional inconveniences to some developers. Hence we accept it with a medium severity.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

Reason for disagreement: Thank you for considering my view point but I am afraid I must stick to the stance that is was a critical part of the DG that was omitted. Any developer working on modifying the UI will take the time to consult the class diagrams in UI and consider how changing front end components may affect other portions.

I believe since the progress display is a critical part that touches many other portions (e.g. tasks from model, connections to other components in UI etc), having this is a necessary part of the DG. As a developer, I would truly be stuck without a good bird's eye view on how this components fits into the bigger picture.

Its omission from the UI class diagram is really jarring and difficult to reconcile with how a DG is supposed to assist me in understanding your codebase. Rather than occasional inconvenience, I am sorry to say I do feel this is a major flaw and I must stick with High severity.