vanessaxuuan / pe

0 stars 0 forks source link

Lacking diagrams in UG #7

Open vanessaxuuan opened 2 years ago

vanessaxuuan commented 2 years ago

Many features like add, edit, addEvent, editEvent etc have very long explanations/documentations but they do not have diagrams to further show how they work.

For example, this is the editEvent's documentation

Screenshot 2022-04-16 at 3.28.03 PM.png

Perhaps a diagram could be added here to allow users to understand how this feature works better. This is because without any diagrams, they might not be able to understand what or where is the `person's full schedule' as described below.

Screenshot 2022-04-16 at 3.29.20 PM.png

soc-se-bot commented 2 years ago

Team's Response

Regarding diagrams: The change in the GUI is minor and the expected result of the successful execution of these commands is intuitive and therefore we shouldn't put any diagram to explain the execution of these commands. So putting more diagrams to an already long (but necessary) explanations will clutter the UG and make it really hard to read. Regarding person's full schedule: By common sense, it should be the person's schedule shown in the schedule panel (The schedule panel definition is there on the earlier part of the UG).

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]