search

kelvinvin / pe

0 stars 0 forks source link

Missing important terms in Glossary #8

Open kelvinvin opened 3 years ago

kelvinvin commented 3 years ago
nus-se-bot commented 3 years ago

Team's Response

Thank you for the feedback! We assume this is referring to the DG (and not the UG) since these terms appear in the DG. We agree that there should be more terms in the glossary but we think the severity of the bug should be very low. The terms "API" and "json" should not be required to be in the glossary as these are terms that developers are familiar with, and their absense in the glossary will not affect the quality of the DG. In the DG, there is a link to a PlantUML tutorial that explains what PlantUML is, so the absense of the term "PlantUML" in the glossary is unlikely to affect the reader's understanding of the document. The other term "JavaFx UI framework" should be in the glossary but its absense is also unlikely to affect normal usage of the document. Also, this was inherited from AB3 as the DG in AB3 did not have these terms in its glossary.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: I agree that while API and json would still be helpful for new developers, but they might not be fully necessary. I must insist that JavaFX and PlantUML should have been included in the glossary as they are key tools that the team has used in developing and documenting the project respectively. They are not commonly recognised and their absence in the glossary would definitely make it harder for readers to follow your explanations in the DG.