jedidiahC / pe

0 stars 0 forks source link

Student missing from the "Main Entities" section of User Guide #7

Open jedidiahC opened 1 year ago

jedidiahC commented 1 year ago

Currently, only the Homework, Lesson and Exam are listed in the "Main Entities" section of the User Guide. However, the user can perform multiple actions to manipulate the Student entity as well (i.e. new-student, update-info, delete, view-profile commands). Hence, the Student entity is an important entity that should be documented under the "Main Entities" section as well.

image.png

nus-pe-script commented 1 year ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Screenshot 2023-04-17 004934.jpg

The "Main Entities" section of the User Guide is specifically intended to provide an overview of the primary entities that the application manages, and as such, it currently includes only the Homework, Lesson, and Exam entities. It is clearly stated at the start of the section and will not cause any confusion to the readers. By Main Entities, our team is referring to the main entities that students possess. Students can possess a student, that is logically unsound. Therefore, we do not agree that we should add students to this section.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]