search

SPWwj / pe

0 stars 0 forks source link

too many redundant infomation use in class diagram #19

Open SPWwj opened 1 year ago

SPWwj commented 1 year ago

Those infomation does not add value to DG, in effect adding cost in maintaining and learning the DG

image.png

nus-pe-bot commented 1 year ago

Team's Response

Thank you for the feedback.

However, AUTOM8 Development Team feel that this does actually add value to the DG.

The main functions that AutoM8 uses to execute the commands come from the Shop class. Hence the team felt that this are necessary information that a future developer need to learn about, in order to implement or enhance features in our application.

In addition, there is needed to provide some background information on how data is stored, so that the following activity diagrams shown in later portions of the developer's guide would make sense.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As a developer, I believe this piece of information seems redundant. The purpose of this diagram should either be to provide information about the Shop API or to encourage other developers to contribute and build upon the Shop class. If you aim to provide information about how AutoM8 executes commands from the Shop class, it would be better to follow the same approach as the original AB3 by referring to their APIs.

On the other hand, if your goal is to showcase the low-level implementation details for your class, it would be more appropriate to include such details for all the classes in your project. Providing implementation details only for the Shop class lacks context and does not offer meaningful information.