Greg-Tan / pe

0 stars 0 forks source link

Format of the UG is not ideal #11

Open Greg-Tan opened 2 months ago

Greg-Tan commented 2 months ago

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

nus-se-bot commented 2 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

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: the payroll explanation was not clearly explained in the context of the app since the scheduling failed to mention how the scheduling works (which is by fixed shifts of 8 hrs a day and not flexible hours) Additionally, your introduction tried to explain scheduling first before payroll retrieval, proving that having the scheduling section before the payroll section makes more sense sequentially. Thus, my documentation bug should not be rejected.

image.png