search

nkotaa / pe

0 stars 0 forks source link

[UG] Missing explanation for creating new courses #11

Open nkotaa opened 2 months ago

nkotaa commented 2 months ago

Description

Whenever a not-in-database course is added, the following prompt that users are given is in fact for the description, and not the course code.

Example: add course CS1010X y/1 t/1 (CS1010X is not an already-in-database course) Following prompt

Course you wish to add does not exist in our database, please provide the course name:

users should type "Programming Methodology" here and not "CS1010X"!

Actual

The UG provides no such explanation.

soc-se-bot commented 2 months ago

Team's Response

Thank you for your suggestion. This is a duplicate of another issue.

The 'Original' Bug

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

Not enough information in the add course function in the User Guide.

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.

image.png

While testing the add function, it is not made known to users that if a course does not exist in the database, they can add a dummy name to the course and users will only realise after inserting a random name and viewing the plan using the view function. This may cause confusion on why a valid module cannot be inserted into the plan and why any name is valid and allow insertion.

[original: nus-cs2113-AY2324S2/pe-interim#1322] [original labels: severity.Medium type.DocumentationBug]

Their Response to the 'Original' Bug

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

Does not affect functionality. When a course that does not exist in the database is added, PlaNUS prompts the user to input the course name, hence we believe that there are instructions provided to the user. We do however agree that we could further explain in our UG.

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 severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** Most definitely affects functionality. A quick test reveals that the application database does not even contain CS2113T! Many GE mods taken by Engineering students are also missing. When such errant `add` commands inevitably happen, the lack of documentation and unintuitive application prompts (as explained in original report) is bound to cause "occasional inconvenience to some users". In other words, it is of `severity.Medium`.