diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7b43615b6d9..8c609d1a6f9 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -8,7 +8,7 @@ show-sticky-toc: true Introducing **TAfinder - the one-stop solution for all your TA selection needs**. -With TAfinder, you can easily: +As an NUS School Of Computing professor, with TAfinder, you can easily: 1. **Manage** troves of TA applicants. 2. Make more **informed decisions** with the help of our **compare** and **sort** functions. 3. **Import** data to the TAfinder application. @@ -458,9 +458,7 @@ Shows a list of applicants. #### Viewing the details of a single applicant: `view` -Displays a single applicant. - -![edit function UI](images/viewUI.png) +Displays the details of a specified applicant in the details panel. **Format:** @@ -468,7 +466,7 @@ Displays a single applicant. **`view INDEX`** -**`INDEX`**: The index corresponding to the applicant to be displayed. The index must be a positive integer (e.g., 1, 2, 3…). +**`INDEX`**: The index corresponding to the applicant you want to be displayed. The index must be a positive integer (e.g., 1, 2, 3…). @@ -479,27 +477,34 @@ Displays a single applicant. **`view 3`** - Displays the following details about the third applicant. - Name - - Student number + - Tags - Phone number - Email Address - GPA + - Previous Grade + - Interview Score - Comments - - Tags - + - Attachments +Following the example above, if you entered everything correctly, you should see the following: + +![view function UI](images/viewUI.png) + **Expected Outputs:**
Successfully displaying all details of an applicant in the following format: - **`Name: John Doe`** -- **`Student number: A0358289S`** +- **`Tags: pastTA, deansList`** - **`Phone Number: 91234567`** - **`Email Address: johndoe@example.come`** - **`GPA: 5.0`** -- **`Comments: Good fit, has teaching experience`** -- **`Tags: pastTA, deansList`** +- **`Previous Grade: A`** +- **`Interview Scorw (optional): 8`** +- **`Comment (optional): Good fit, has teaching experience`** +- **`Attachments: Resume.pdf`** Confirmation message:
**`"Displaying: APPLICANT_NAME"`** @@ -622,6 +627,59 @@ Index out of range:
--- +#### Clearing all applicants: `clear` + +Clears your entire list of applicants. + +**Format:** + +
+ +**`clear`** + +
+ +Following the example above, if you entered everything correctly, you should see the following: + + +| Before | After | +|:-----------------------------------------------:|:----------------------------------------------:| +| ![clear function UI](images/clear_beforeUI.png) | ![clear function UI](images/clear_afterUI.png) | + +**Expected Outputs:** + +
+ +Successfully clearing all applicants.
+**`"Applicant list has been cleared!"`** + +
+ + +--- + +#### Exiting the application: `exit` + +Exits the application, while ensuring all your changes are saved. + +**Format:** + +
+ +**`exit`** + +
+ +**Expected Outputs:** + +
+ +- Application closes. + +
+ +--- + ### Applicant evaluation & comparison #### Sorting applicants by GPA: `sort` @@ -725,21 +783,17 @@ Comparing the same applicant:
--- -#### Bookmarking/Unbookmarking applicants: `bookmark/unbookmark` +#### Bookmarking applicants: `bookmark`/`unbookmark` Bookmarks/Unbookmarks a specific applicant. -| Before | After | -|:-----------------------------------------------------:|:----------------------------------:| -| ![bookmark function UI](images/bookmark_beforeUI.png) | ![bookmark function UI](images/bookmark_afterUI.png) | - **Format:**
**`bookmark INDEX` / `unbookmark INDEX`** -**`INDEX`**: The index corresponding to the applicant to be bookmarked/unbookmarked. The index must be a positive integer (e.g., 1, 2, 3…). +**`INDEX`**: The index corresponding to the applicant you want to bookmark/unbookmark. The index must be a positive integer (e.g., 1, 2, 3…).
@@ -747,18 +801,31 @@ Bookmarks/Unbookmarks a specific applicant.
-**`bookmark 3`** -- Bookmarks the third applicant. +**`bookmark 2`** +- Bookmarks the second applicant.
+Following the example above, if you entered everything correctly, you should see the following: + +| Before | After | +|:-----------------------------------------------------:|:----------------------------------:| +| ![bookmark function UI](images/bookmark_beforeUI.png) | ![bookmark function UI](images/bookmark_afterUI.png) | +
-**`unbookmark 3`** -- Unbookmarks the third applicant. +**`unbookmark 2`** +- Unbookmarks the second applicant.
+Following the example above, if you entered everything correctly, you should see the following: + +| Before | After | +|:---------------------------------------------------------:|:--------------------------------------------------------:| +| ![unbookmark function UI](images/unbookmark_beforeUI.png) | ![unbookmark function UI](images/unbookmark_afterUI.png) | + + **Expected Outputs:**
@@ -790,7 +857,7 @@ Index out of range:
--- -#### Commenting on TA applicant: **`comment`** +#### Commenting on applicant: `comment` One of yours TAs is unable to make it for the interview. You want to make a comment on the applicant to remind yourself to follow up with him/her. @@ -852,6 +919,7 @@ Index out of range:
+ --- ### Files and data management @@ -990,13 +1058,13 @@ TAfinder data are saved in the hard disk automatically after any command that ch TAfinder data are saved automatically as a JSON file `[JAR file location]/data/tafinder.json`. Advanced users are welcome to update data directly by editing that data file. - - **Warning:** +
+ If your changes to the data file makes its format invalid, TAfinder will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it. - +
-------------------------------------------------------------------------------------------------------------------- ## Upcoming Features [coming in a future update!] diff --git a/docs/images/clear_afterUI.png b/docs/images/clear_afterUI.png new file mode 100644 index 00000000000..1df23d4df8d Binary files /dev/null and b/docs/images/clear_afterUI.png differ diff --git a/docs/images/clear_beforeUI.png b/docs/images/clear_beforeUI.png new file mode 100644 index 00000000000..ce79e615a29 Binary files /dev/null and b/docs/images/clear_beforeUI.png differ diff --git a/docs/images/unbookmark_afterUI.png b/docs/images/unbookmark_afterUI.png new file mode 100644 index 00000000000..97779e8c3d2 Binary files /dev/null and b/docs/images/unbookmark_afterUI.png differ diff --git a/docs/images/unbookmark_beforeUI.png b/docs/images/unbookmark_beforeUI.png new file mode 100644 index 00000000000..a75100a8ea6 Binary files /dev/null and b/docs/images/unbookmark_beforeUI.png differ