cheehongw/pe

pe's Issues

user guide lacking screenshots

The user guide contains only 1 image which depicts the help window.

For example, this section on editTask could use a screen shot of the actual taskList (an image of the product) rather than just a bunch of text so users know what is going on.

Too much text in this section makes it hard to follow as well.

`findEmployee` too strict

Problem:

A user might want to use the findEmployee command to find some user that they cannot fully remember the details of. For example, they could only vaguely remember part of the name, and might try searching via that keyword.

In the example picture below, the user may want to find all users with Test in their names, however, since the findEmployee is too strict and only matches exactly the word, this command returns no results.

text in point form should use github bullet point markdown

In the section indicated in the image below, the section written in point form should use bullet points for better visibility.

Not allowed to add an event that starts at 2359 and ends in the next day

addEvent desc/Go party at zouk!!! at/2022-04-16 2359 0640

Expected:

• Should be allowed to add an event that rolls over to the next day

Actual:

• The event is rejected because ENDTIME is treated as the same day!

Consecutive valid special chars in email is rejected

Steps to reproduce:

1. Try to add employee with an email containing consecutive special chars:

addEmployee n/Tester p/12345678 e/[email protected]

Expected:

email with consecutive special chars are to be accepted based on what is specified in the error text for email:

Actual:

The above invalid email message

Rationale:
This is at least a medium level functionality bug since it is not rare that users have consecutive special chars in their emails.

`FAQ` section of the UG is lacking

There is only 1 FAQ. The FAQ is also a section where the user goes to when they encounter a problem

How about common FAQs that handle common user queries on exceptional events? e.g.

Q: My application started up blank! What happened?

A: {explaination of what happened}

No corrupt save file warning presented to user

Expected:

In the rare event that the save file is corrupted, the product should inform the user that the savefile has been corrupted. Otherwise, the user might panic as to why their files got removed all of a sudden.

Actual:

1. Try corrupting the savefile by making it an invalid json
2. Launch the product
3. No notification/warning is given

Wrong command for `listTask` in UG

Command summary of UG provided an invalid command for listTasks (should be listTask). In the worse case, the user may not find out how to list out their tasks.

employee name with commas will clear the addressbook on next launch

assigning a user to a task with commas in their name will clear the addressbook on next launch