search

Timothyoung97 / pe

0 stars 0 forks source link

A lot of instances of AB3 #7

Open Timothyoung97 opened 2 years ago

Timothyoung97 commented 2 years ago

After reading through DG, I realised that Many areas remain as AB3. Should not have so many AB3, since it is a different product. Very hard to reference.

image.png

image.png

In addition, I believe that the architecture of the product is now different from AB3 since the team added quite a lot of features such as lessons, edit remark panels.

all these should be included in the architecture diagram

nus-pe-bot commented 2 years ago

Team's Response

Accepted that DG Architecture should include new components added on top of base AB3.

The phrases 'AB3' and 'addressbook' are still used in some areas of code and documentation due to TutAssistor being based on and keeping certain aspects of AB3, including the addressbook functionality. This is stated in the acknowledgements section at the start of the DG.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Medium] Originally [severity.High]

Reason for disagreement: As a tester, I agree with the change of severity from High to Medium.

However, I want to remind the team that if the product is already changed from AB3 into another different product, all the relevant changes should be done as well. This is because it introduces a lot of complexity in reading the DG when there are two very different namings are found and makes it hard for a SWEer to understand the project.

Imagine, you're an intern / new employee / open-source dev, and you have to read the DG, feeling lost on AB3 and your product, how does that feel? Won't it introduce a lot of stress?

However, as we are still new to SWE, I agree with the team in the change of severity.