search

BuffWuff1712 / pe

0 stars 0 forks source link

No sequeunce diagrams found in DG #13

Open BuffWuff1712 opened 1 week ago

BuffWuff1712 commented 1 week ago

as per title

image.png

nus-pe-bot commented 5 days ago

Team's Response

Thank you for pointing out this bug! However, we believe that we have explained our implementation and design choices well using UML diagrams for Model, Logic, Storage etc in the Developer Guide before. Based on this, we made a deliberate decision not to include additional UML diagrams, such as Sequence diagrams, to demonstrate implementation and behavior.

Our rationale was to avoid overcomplicating the documentation, since having too many diagrams - especially those with low-level details - could deter developers from engaging with the material. We aimed to strike a balance between clarity and conciseness, focusing on providing a clear understanding of the overall system design.

Hence, we are putting this bug as response.NotInScope. That said, we acknowledge your feedback and are considering the inclusion of more UML diagrams, including high-level Sequence diagrams, in future iterations to further enhance the Developer Guide. We hope that you can find common ground with us on this, thank you once again for pointing this out!

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]