search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

Calendar View Documentations #3135

Open nus-pe-bot opened 3 years ago

nus-pe-bot commented 3 years 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.

The Calendar View is explicitly shown in the introduction.

image.png

But actual references of the calendar view has only three mentions that are subsidiary to other features.

image.png

Given that this is a very long User Guide, users can be very confused with how to use the calendar view, given that it is a purely GUI functions while TutorTracker should be optimized for CLI usage.

Marking this as a Medium because I was very confused.

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

glatiuden commented 3 years ago

Team's Response

Dear responder, I understand that TutorTracker is optimized for CLI usage, but however, we don't see why is it very confusing because, indeed, it only supports and is a subsidiary of three commands, which are view_appointment, view_schedule and view_event.

The diagram in your first screenshot is to allow users to know the existence of such a calendar.

Let us take consider an example, purchasing a router. A typical procedure is to read the instruction manual and understand how we set up the router to gain internet access. If you noticed, there are other miscellaneous buttons, such as the WPS button. The calendar here is the same as the WPS button. Both provide an easier method to perform an action. However, suppose the user decides not to read the instruction but pressed the WPS on his/her own will. In that case, it is not within the manufacturer's control if something went wrong since the instruction manual should already educate the user on its functionality. Likewise, for the calendar, we will explicitly mention its usage if the particular command supports it. We believe it's inappropriate for us to mention that the calendar in each unsupported command. We believe it should be appropriate only to mention the calendar in the commands that support it. Hence, the description was given in each view command. Suppose you, as a user, felt that the calendar was confusing and tried clicking it without reading the UG thoroughly. In that case, it is not the responsibility of us, the developers, since it's already documented down.

Otherwise, the calendar meant for cosmetic display purposes. We don't see how it caused any major confusion or obstruction to the user when operating the other CLI commands. As mentioned, TutorTracker should be optimized for CLI usage. The focus is still CLI, but it gives the benefit of "short-cut" through GUI.

Duplicate status (if any):

--