Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit UG for Help, AddInterview, AddApplicant and AddInterviewer commands #240

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 32 additions & 11 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,29 @@ while still having the benefits of a Graphical User Interface (GUI).

* We give you the freedom to make any edits to the addressbook.json file but do not that if any invalid edits (such as adding in `null`, non-english alphabet or emojis) are made to the addressbook.json before (re)launching the application, then no data will load and an exception will be viewed in the terminal.

## Launching help window : `help` ##
This is your first time opening Tether and you are unfamiliar with the commands. It would be nice to receive some guidance about the commands.
This is where `help` command is here to help.
Simply execute `help` and this will launch the help window. You can also press the help button to launch it as well.

Format : `help`
![img.png](img.png)

## Adding an applicant: `add_applicant`
To get started on using Tether, add an applicant whose resume you just received.

Format: `add_applicant n/NAME p/PHONE e/EMAIL [t/TAG]`
Simply execute `add_applicant n/NAME p/PHONE e/EMAIL`. The required applicant's information is their name, phone number and email address.
The applicant will appear under the `Persons` column.

Examples:
![img_1.png](img_1.png)

Examples:
* `add_applicant n/John Doe p/81239123 e/[email protected]`
* `add_applicant n/John Doe p/81239123 e/[email protected] t/friends t/cool`
* `add_applicant n/Wesley Yu p/88889999 e/[email protected]`

**Notes**:
* Different applicants with the same name can be entered as long as their phone numbers and emails are different.
* Remark field will empty and can only be added upon entering `remark` command.

Note that the remark field would be empty be default and can only be changed after the person is added.

Expand All @@ -93,19 +107,22 @@ A simple example usage would therefore be
* For convenience, STATUS is case-insensitive i.e. `s/accepted` is as valid as `s/AcCepTed`.
* If you add an interview, the involved applicant's status will change automatically from "resume review" to "pending interview". Conversely if you delete an interview involving an applicant, their status will _revert_ to "resume review"

## Adding a interviewer: `add_interviewer`
## Adding an interviewer: `add_interviewer`
Now that you have all your required applicants, you would like to schedule an interview. But before that, you would need to enter the interviewer needed to conduct the interview.

Adds an interviewer to the Tether.
Simply execute `add_interviewer n/NAME p/PHONE e/EMAIL`. The required interviewer's information is their name, phone number and email address.
The interviewer will appear under the `Persons` column.

Format: `add_interviewer n/NAME p/PHONE e/EMAIL [t/TAG]`
![img_2.png](img_2.png)

Examples:

* `add_interviewer n/John Doe p/81239123 e/[email protected]`
* `add_interviewer n/John Doe p/81239123 e/johndoe123@gmail.com t/friends t/cool`
* `add_interviewer n/Yash p/99998888 e/yash@gmail.com`

Note that the remark field would be empty be default and can only be changed after the person is added.

**Notes**:
* Different interviewers with the same name can be entered as long as their phone numbers and emails are different.
* Remark field will empty and can only be added upon entering `remark` command.

## Adding a status to an interviewer: `interviewer_status`

Expand Down Expand Up @@ -146,14 +163,18 @@ If you would like to not have a description, simply leave it blank with the keyw
Upon successful addition, the interview will appear under the column named `Upcoming Interviews`.

Simply execute the command show below to start scheduling an interview.
Format: `add_interview desc/DESCRIPTION date/DATE st/START TIME et/END TIME a/APPLICANT'S
PHONE NUMBER i/INTERVIEWER'S PHONE NUMBER`
Format: `add_interview desc/DESCRIPTION date/DATE st/START_TIME et/END_TIME a/APPLICANT_PHONE_NUMBER i/INTERVIEWER_PHONE_NUMBER`

A simple example usage would be `add_interview desc/technical date/2024-11-11 st/12:00 et/15:00 a/12345678 i/87654321`.
Executing this would result in the following display:

![img.png](images/addInterviewExample.png)

**Notes**:

* You can still schedule new interviews for applicants who have already been rejected or accepted. This is because there can follow up or subsequent interviews.


## Listing all persons:

Now that you have added multiple `Applicants` and `Interviewers` into Tether, it would be nice to view them with their
Expand Down
Binary file added docs/img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading