j-dan23 / pe Goto Github PK

While the UG does include example commands for the user to experiment with, it could benefit from more screenshots displaying (at least) the response of the application after the example command has been entered.

This can help give users a peace of mind, as they know that they inputted the command correctly. This is especially so for commands with more parameters, options (eg module add <MODULE_CODE>), or for those with very informative error messages (eg specialisation SPEC).

Note: ACC1002 is an existing module in the list.

1. Scrolled down, then typed "ACC1002" into the search screen and pressed the search button:
   
   (Result message is due to a previous successful "student list" command)
   

According to the UG, searching for modules should be done by typing the module code in full, as was done in the above.

Slightly nitpicky: While the figure/screenshot does show what the button looks like (and the app is entirely in one window), it might be more helpful to show the full app then circle where the button is - helps a new user navigate better.

(excuse the dark line - that's a gap between the pages due to adobe reader)

Further nitpicking from me: Is it Module Panel Screen or View?:

This isn't a major issue, but inconsistencies might confuse a new user who might be mislead to believe they refer to different things, for example.

Edit:
This seems to be a repeated problem, as it happens for the following sections 4.6.1, 4.6.2 and 4.7 at the least.

Displayed message is due to a previous successful "set major IS" command.

1. typed "set major CEng" into command, pressed enter.
2. no display of erroronous command in the application, but an exception is caught in cmd.

It would be nice to have feedback for this erronous command in the application window itself. But the app doesn't crash, so it's not a major issue.

The command gives an error message when only "specialisation spec" is entered, prompting further input of the SPEC:

Thus, given that it is an error message and not a successful command, perhaps SPEC should not be in square braces as shown below?:

UG:
Section is on the "clear" command, but the Format section shows "exit" instead.

1. Entered "module add <valid module from student's major>" repeatedly. The modules are ticked off, and additionally all count towards UE.
   

(error message in results display is due to a previous "specialisation set algo" command, that was not applicable with current active student. No issue with this.)

1. Using the error message, typed "specialisation set di" for active student Alice, of IS major:
   
2. Result shows that her specialisation is set to null:
   
3. Attempted to set a CS student's specialisation instead. Command functions properly:
   

Note: If this error is due to my misunderstanding how the command works, it could be a UG bug instead (lack of clarity in UG instructions for specialisation set command).

The below image displays what modules the student is taking:

The command "module remove cs1101s acc1002 remove acc1006" is keyed in, then enter is pressed.

Error message only detects the first erronous module and not all modules (both ACC modules). While not a huge issue, it could be inconvenient as the user might have to remove/fix errors one by one rather than knowing all errors at once.