nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Format of the UG is not ideal #3779

Open nus-se-script opened 4 months ago

nus-se-script commented 4 months 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.


In your ug, the payroll section comes before schedule which is confusing as a user because prior to reading the payroll commands section, there is no mention of shifts or start dates or end dates for the persons in the contact list which was confusing as to what the function is calculating and where the addressbook gets the values shown from. Only after I skipped that section and read the schedule commands section then it made sense. Hence, schedule commands section should come first in your ug for the ug to be more smooth sailing


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

jxunze commented 4 months ago

Team's Response

We agree that it might be clearer if we put the payroll explanation before schedule. However, we did explain about the schedule and payroll pages before the features section, hence it should not be an issue if the reader reads sequentially. Screenshot 2024-04-21 at 10.00.47 PM.png

Duplicate status (if any):

--