search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Lack of glossary terms #237

Open nus-se-script opened 9 months ago

nus-se-script commented 9 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

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

[original: nus-cs2103-AY2324S1/pe-interim#206] [original labels: severity.Low type.DocumentationBug]

Weiennn 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.

Duplicate status (if any):

--