nus-pe-bot
commented
1 year ago Team's Response
Rejected as the developers would be using the DG as reference to see the inner workings of the app and not the UG. The UG is meant for users to learn how to use the app, and is not required to follow the exact naming convention for technical component names used in the implementation as detailed in the DG.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: I still feel that there is a documentation bug here, as the issue is not about the UG to reference the DG. The issue is that in the DG class diagram for UI, it points to a class PersonListPanel that references PersonCard. However, in the actual implementation the Ui also displays wards on the list panel.
As I mentioned in my bug report:
This can be confusing as this may lead developers to assume that there is a
WardListPanel, given that the lsward function exists.
Either way, the PersonListPanel in the class diagram should be renamed to let developers know that the PersonListPanel is responsible for displaying either persons or wards, depending on the context.
Under DG UI Component (pg 6)
The class diagram is as follows:
However in the UG, the Ui component of interest is named ListPanel:
Justification
This can be confusing as this may lead developers to assume that there is a
WardListPanel, given that thelswardfunction exists.