search

mamayuan / pe

0 stars 0 forks source link

Lack of glossary terms #10

Open mamayuan opened 9 months ago

mamayuan commented 9 months ago

Currently, only three terms are explained while UI is one of the three. Then terms such as 'activity diagram,sequence diagram,GUI,JavaFx UI framework,JSON,interface,package` should also be documented for better clarification image.png

nus-pe-script commented 9 months ago

Team's Response

Thank you for your response. Our decision to omit certain terms from the developer's guide was based on the assumption that our readers, being developers, would already be familiar with these concepts. If we do add terms such as activity diagram, sequence diagram, GUI, JavaFx UI framework, JSON, interface, package, we would have to even more terms such as Activity bar, Class, Abstract, it is unclear where to stop.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I disagree with the team's rationale for omitting certain terms from the developer's guide. While it's understood that the guide is intended for developers who might be familiar with these concepts, the inclusion of comprehensive examples in other parts of the guide suggests a thorough approach to explanation and clarity. Given that 'UI' has been included as a glossary term, it sets a precedent for including terms of similar complexity. It is unreasonable to keep 'UI' while leaving out so many other terms. Therefore, terms like 'GUI', 'JavaFx UI framework', and others I proposed should also be considered for inclusion. The argument that it is unclear where to stop adding terms seems more like a matter of convenience than a well-founded limitation, especially considering the detailed nature of the rest of the guide.