tanyunchao / pe

0 stars 0 forks source link

Inconsistent naming in DG use cases #11

Open tanyunchao opened 5 months ago

tanyunchao commented 5 months ago

(For all use cases below, the System is the AddressBook and the Actor is the user, unless specified otherwise)

  1. CapitalConnect dashboard prompts the user to provide details including:

AddressBook referred to as the system but in the actual MSS document uses CapitalConnect instead

nus-pe-bot commented 5 months ago

Team's Response

No details provided by team.

The 'Original' Bug

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

System is AddressBook instead of CapitalConnect in DG

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.


Under Use cases the system should be CapitalConnect.

image.png


[original: nus-cs2103-AY2324S2/pe-interim#3652] [original labels: type.DocumentationBug severity.VeryLow]

Their Response to the 'Original' Bug

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

image.png

Since it is optional to do a comprehensive renaming, our system is indeed called Addressbook

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 explanation]


## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** I believe the ss you provided in the response refers to the Java package in the docs. In this case, we are referring to how you are labelling your system in the DG which I believe is not covered by that screenshot. I think renaming packages being optional only applies within the code base and note the DG/UG