yusufaine/pe

pe's Issues

[ug-clear] clear should warn users about how there isn't a way to confirm the command or the actions cannot be undone

Caution message was used for "Editing the data file", and I feel like clear warrants a caution message as well

[schedule-add] minor issue on the feedback message -- not sure what is "invalid" about this command based off the error message

This is a very small nit, but I think it would be good if the error message can indicate which part of the date-time is invalid

[docs-dg] Missing "extension"?

Some of the MSS were missing the "Extension"

[docs-dg] MSS for Add

---

I might be wrong but shouldn't this process be 2 steps?

Such as:

1. User requests to add new candidate with their details.
2. TA... adds the new candidate

Extension:
2a. Command is invalid
    2a1. Shows error message
    Use case ends
2b. Candidate already exists
    2b1. Shows duplicate message
    Use case ends

[docs] Localise to UK English

Really nitpicking at this point -- I remembered having a discussion about this with my 2101 tutor and how we should use UK English since the audience is primarily Singaporeans, who use UK English so the spelling of some words and grammar should reflect that.

Example:

• Centralise
• Optimise

[name validity] should names be restricted to alpha numeric only?

I think valid names can include:

• Damith C. Rajapakse, or
• Lee Ji-Eun

For the first instance, it can be said that "C." is abbreviated, but I'm not too sure about the 2nd case.

[docs-UG] file name in quick start

Small nit on the name of the file

Current latest version follows the submission convention, but the User Guide mentions "TAlentAssistant.jar", users might download the previous release since that follows the name.

v1.4

v1.3.1

[invalid command feedback] not very useful feedback message

From the previous issue on whether names should strictly be alpha-numeric, the feedback message could have been a little more specific on which portion of the command is causing the issue.

I clearly know that it is the name since I was testing it but it might not be very obvious for users unless they refer to the user guide.

[docs-dg] Acknowledgement

I believe the DG should specify where the icon was obtained instead of a direct link to the icon itself, and mention how AB-3 and JavaFX was used.

[docs-dg] formatting with page breaks

Small nit, similar to the UG, the content is really well-written but could be improved by using page breaks to avoid issues like these:

[docs-ug] double click to run

Currently on MacOS and it isn't possible to double-click to run by default. There is a way to allow this behaviour but the users would need to tinker their own system.

Suggestion:

• Running the app via terminal/command prompt using java -jar [file.jar]

docs br not rendered

[abstracting common functionality] managing candidates and scheduling interviews

Seeing as how candidates and schedule has similar CRUD functionality, I think it would be easier for the user to specify a special flag/prefix to denote whether an action is done for candidate or interviews. The need to specify schedule feels a bit unnecessary, considering CLI applications also use flags/prefix to denote accordingly

Example:

• add: add -c [fields] -- for candidates, and add -i [fields] -- for interviews
• view: view -c [index], and view -i [index], or
• delete: delete -c [index], and delete -i [index]

---

[docs-schedule expiry]

While it makes sense for schedules to expire after its session, I see a use case where that might be bad, for instance, if the user themselves forgot about the interview that day, opens the app the next day, and it's marked as completed.

Perhaps it would be better to leave them as is or use a new status to denote that the interview was missed.

[docs-ug] formatting of different sections

Based on the screenshot below, focus is under the "Managing candidates" header, and "Scheduling interviews" is a new category/header.

Suggestion:

• Page break before new headers/categories

[clear] confirmation message/prompt

Clear is a very power command which works as intended, but it would be unfortunate if a user clears all their data without some sort of confirmation message.

Suggestions:

1. Confirmation message
   • Specific command to bypass confirmation clear -f
2. undo command

[docs-ug] (lack of) usage of page breaks

There are sections in the User Guide where short sections are split into 2 pages, or headers are "left behind", which could easily be resolved by using page breaks as mentioned in the se-edu tutorial. It doesn't have to be for every section, just those that would help improve readability.

[docs-ug] Improving navigability

I think the navigability of the UG can be improved by including a small hyperlink to jump back to command summary or linking the features in the command summary to their respective explanations. Would have made testing and reading UG a lot easier, but again, this is just a minor issue.

[gui-rendering] text seems to clip

in the command box, "John Doe"'s "oe" seems to be clipped and I thought I had made a typo.

dummy issue - edit

test