search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

AddressBook references not removed in DG #2898

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

page 6 Screenshot 2021-04-16 at 3.20.05 PM.png

page 9 Screenshot 2021-04-16 at 3.20.30 PM.png

2 other instances on pages 8 and 10.

No other mention of AddressBook, rather distracting as application is a patient database and has no relevance to AddressBook. Could perhaps consider naming it something else like PatientBook :)

below is the value proposition. no mention of "Address" here, might leave the reader wondering where "AddressBook" came from.

Screenshot 2021-04-16 at 3.22.00 PM.png

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

prerthan99 commented 3 years ago

Team's Response

Thank you for the find. We noticed that several of our reported bugs have to do with elements of the original AB3 documentation still being in the our DG. These wrong namings and AB3 references will indeed confuse readers.

We agree that the summation of all AB3 reference-related bugs indeed constitutes a medium severity level bug, but we view it to be reasonable to also lump the other references to AB3 within our DG within this single bug find.

For tutors: We have included within the duplicated issues bugs pointing out other parts of the DG having AB3 references.

Duplicate status (if any):

--