search

lamwj98 / pe

0 stars 0 forks source link

listdriver implemention details insufficient #14

Open lamwj98 opened 2 years ago

lamwj98 commented 2 years ago

Diagrams could be used to depict the implementation better, without the diagrams and with so many different classes, developers cannot get the correct picture of the implementation properly and may result in improper future development of the functionality.

Screenshot 2022-04-16 at 3.18.46 PM.png

soc-se-bot commented 2 years ago

Team's Response

Listing as duplicate as stated in #2160

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

revenue implementation lacks depiction

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.

revenue lacks the depiction in terms of diagrams and with many classes involve, developers may not be able to understand the details of implementation. Hence, it would be better to include depict these details through UML diagrams.

Without diagram, implementation will not be properly understood by developers and they could be improper enhancement to the feature in future.

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Hi tester, thanks for pointing this out! Our team left out the UML diagrams for some of the commands as the diagrams are similar (in fact, almost identical) to the other commands listed, eg. Add/Delete/Edit driver, Add customer, etc.

The addition of multiple duplicated diagrams for every command with slight changes in method names is unnecessary in our opinion. Moreover, step-by-step descriptions were provided in the DG for every command, which is sufficient in our opinion to understand that the nature and process of each command is similar in nature.

Understood that there are multiple issues, one for each command posted with the same description. Will be listing the rest as duplicates of this as well :)

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your reason] It is of similar context but for different part of the documentation, hence, it constitutes as separate bug because resolving one part does not resolve the other.

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason] I would disagree because there's too many classes involve, as a developer joining the project, I may not be to follow up on the details describe without a proper diagram, and may end up just skipping this whole section in the documentation without achieving the intention of the writer of this part of the documentation (to allow new developers to understand the implementation)