nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Missing terms in glossary #1861

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.


Think there are a couple of technical terms in the DG that should have been highlighted in the Glossary, for example: " Route planning" and "Inventory Management" as seen in the NFR section.

Given that these are managerial related terms, I think it would be good to have explained such terms since developers might not know what it means and this affects how they implement the features.


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

jianyangg commented 9 months ago

Team's Response

These terms are not specific to HomeBoss to make it noteworthy enough, abbreviation or an acronym. We believed that these terms would be understood by the vast majority. “Route planning” would be planning for routes for delivery and “inventory management” would clearly for managing ones’ items/stock. This was why we did not include it in the glossary as we thought it was quite straightforward. If more developers did not understand it (unlikely the case), we could perhaps add it in in our future iteration as per the definition of NotInScope.

Screenshot 2023-11-20 at 12.02.38 PM.png

Duplicate status (if any):

--