Skip to content

Commit

Permalink
Merge pull request #242 from AriellaCallista/branch-Documentation
Browse files Browse the repository at this point in the history 
Branch UG
  • Loading branch information
@ketweeen
ketweeen authored Nov 15, 2023
2 parents 08032dd + ca91f3c commit b46d9c1
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ Access our self-curated user guide below to learn more on how you can integrate

[Jump back to Table of Contents](#table-of-contents)

--------------------------------------------------------------------------------------------------------------------
## Features Overview

While **JABPro** offers a whole range of features, we believe that the following features are likely to be the most useful to you:
Expand Down Expand Up @@ -381,7 +380,7 @@ Format: `listT`
[Jump back to Table of Contents](#table-of-contents)

<div style="page-break-after: always;"></div>
--------------------------------------------------------------------------------------------------------------------


### 2. Managing Applicants
<a name="2-managing-applicants"></a>
Expand Down Expand Up @@ -670,10 +669,11 @@ Format: `edit INDEX ([n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAGNAME]…​
* If you have **multiple tags in different categories with the same name**, you must **specify the category** when you want to tag the specified applicant with one of these tags e.g. `edit INDEX t/CATEGORY DUPLICATETAGNAME`


<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>


* If you still would like to tag an applicant that has **not** been created, but you do not want this tag to be _uncategorized_, you can do so by doing
`edit INDEX t/CATEGORY TAGNAME`.

Expand All @@ -694,10 +694,11 @@ This is because, `create` only creates **new** categorized tags. It does **not**



<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>


* You can also tag the applicant and edit their score **at the same time** by doing `edit INDEX t/TAGNAME sc/TAGNAME SCORE`.
* Note that the tag has to have already been created using `create` with the category `assessment`. You **cannot** do this with a tag that hasn't been created even if you specified its category _assessment_ i.e. `edit INDEX t/assessment interview1 sc/interview1 100` does **NOT**
work. This is because, you cannot create tag and edit score at the same time as editing score relies on the fact that the tag has already existed.
Expand Down Expand Up @@ -789,11 +790,12 @@ Format: `delete (t/TAGNAME... st/STATUS...)`
* Delete parameters are case-insensitive i.e. doing `delete t/interN` is the same as `delete t/intern`


<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>



**Note:**
* You can combine multiple delete categories in a single `delete` command e.g. `delete st/interviewed t/intern`

Expand Down Expand Up @@ -877,11 +879,12 @@ Format: `search (n/NAME... st/STATUS... t/TAGNAME...)`
* Search parameters are case-insensitive i.e. doing `search n/aLeX` is the same as `search n/alex`


<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>



**Note:**
* You can combine multiple search categories in a single `search` command e.g. `search n/alex st/interviewed t/intern`

Expand Down Expand Up @@ -1172,11 +1175,12 @@ Format: `exit`
## Additional information
<a name="additional-information"></a>

<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>



### Summary Statistics

Summary Statistics is a table generated by JABPro that displays the following information about an applicant:
Expand Down Expand Up @@ -1211,11 +1215,12 @@ You should ensure that you have **sufficient candidates of more than 20** with a
3. `percentile` as where this applicant stands among all other applicants (treat it like a ranking system, the higher the percentile, the better the applicant is performing)
</box>

<div style="display: flex; justify-content: center; align-items:center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 15px; font-weight: bold;">Advanced</p>
<div style="display: flex; justify-content: center; background-color: #FF0000; padding: 10px; border-radius: 30px; width: 100px; height: 50px; text-align: center;">
<p style="color: #FFFFFF; font-size: 17px; font-weight: bold;">Advanced</p>
</div>



**Note**:
* Understand that `percentile` has limited functionality in some context. This is because if two applicants have the same score, they are `rank` the same. This means that the percentile of both applicants will be the same.
* If all applicants have the same score, their percentile will all be 0.0. This is because they are all `rank` the same.
Expand Down

0 comments on commit b46d9c1

Please sign in to comment.