Update docs/UserGuide.adoc

docs/UserGuide.adoc

@@ -18,7 +18,7 @@ By: `T16-3`      Since: `Aug 2018`      Licence: `MIT`
 
 == Introduction
 Bank AddressBook (BankAB) is an employee management application.
-You can use BankAB to check working schedule, apply off day, check working hours, access payroll
+You can use BankAB to check working schedule, apply off day, check working hours
 and daily notification. The managers and boss will have more access of BankAB such as changing the
 priority level of the employee and approve or reject off day requests. This user guide will give
 you step by step instruction on how you can use the features of BankAB.
@@ -27,19 +27,20 @@ you step by step instruction on how you can use the features of BankAB.
 
 .  Ensure you have Java version `9` or later installed in your Computer.
     https://www.oracle.com/technetwork/java/javase/downloads/index.html[Download]
-.  Download the latest `addressbook.jar` link:{repoURL}/releases[here].
+.  Download the latest `BankAddressBook.jar` link:{repoURL}/releases[here].
 .  Copy the file to the folder you want to use as the home folder for your Address Book.
 .  Double-click the file to start the app. The GUI should appear in a few seconds.
 +
 image::Ui.png[width="790"]
 +
 .  Type the command in the command box and press kbd:[Enter] to execute it. +
 e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
-.  A sample list of contacts will be provided when the application is first run.
+.  The following table contains a sample list of persons with the respective account details when the application is first run
+ or when ResetCommand was executed in the previous runtime.
 
 .List of user accounts at first launch or upon reset
 |===
-|Name |NRIC |Password |Priority Level
+|*Name* |*NRIC* |*Password* |*Priority Level*
 |Highest Admin Account
 |S1230000E
 |Password
@@ -53,6 +54,11 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
 |Bernice Yu
 |T1234567E
 |Password
+|MANAGER
+
+|Charlotte Oliveiro
+|F1234567E
+|Password
 |BASIC (Lowest Priority Level)
 |===
 .  Some example commands you can try:
@@ -104,9 +110,8 @@ Examples:
 
 * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 d/Junior Management ic/T0249855I
 pwd/9EwciT plvl/1`
-* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 d/Senior Management
-t/criminal
-ic/S1875858E pwd/Fed528F`
+* `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Tower p/1234567 d/Senior Management
+t/Creditor ic/S1875858E pwd/Fed528F`
 
 === Listing all persons : `list`
 
@@ -397,71 +402,6 @@ Format: `history`
 Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and next input respectively in the command box.
 ====
 
-// tag::undoredo[]
-=== Undoing previous command : `undo`
-
-Restores the address book to the state before the previous _undoable_ command was executed. +
-Format: `undo`
-
-[NOTE]
-====
-Undoable commands: those commands that modify the address book's content (`add`, `delete`, `edit` and `clear`).
-====
-
-Examples:
-
-* `delete 1` +
-`list` +
-`undo` (reverses the `delete 1` command) +
-
-* `select 1` +
-`list` +
-`undo` +
-The `undo` command fails as there are no undoable commands executed previously.
-
-* `delete 1` +
-`clear` +
-`undo` (reverses the `clear` command) +
-`undo` (reverses the `delete 1` command) +
-
-
-=== Redoing the previously undone command : `redo`
-
-Reverses the most recent `undo` command. +
-Format: `redo`
-
-Examples:
-
-* `delete 1` +
-`undo` (reverses the `delete 1` command) +
-`redo` (reapplies the `delete 1` command) +
-
-* `delete 1` +
-`redo` +
-The `redo` command fails as there are no `undo` commands executed previously.
-
-* `delete 1` +
-`clear` +
-`undo` (reverses the `clear` command) +
-`undo` (reverses the `delete 1` command) +
-`redo` (reapplies the `delete 1` command) +
-`redo` (reapplies the `clear` command) +
-// end::undoredo[]
-
-//Reason for block comment: Not implemented yet.
-////
-=== Setting password: `setpass`
-Set password for employee on the address book. +
-Format: `setpass n/NAME ic/s1234567h sp/PASSWORD` +
-
-* The password is case sensitive. +
-* Password length is limited to 15 characters. +
-* Password must include both upper-case and lower-case letters and inclusion of one or more numerical digits. +
-* Example: `setpass n/John Doe ic/s1234567h sp/PaS88od` +
-====
-Sets PaS88of as a password for John Doe.
-====
-////
 === Login to the application: `login`
 Logs in to the application using a registered NRIC and password. +
 Format: `login ic/NRIC pwd/PASSWORD` +
@@ -517,11 +457,6 @@ Format: `setschedule INDEX ts/TIME_START te/TIME_END v/VENUE` +
 Example: `setschedule INDEX ts/1100 te/1600 v/Toilet` +
 // end::schedule[]
 
-=== Access payroll: `payroll`
-List payroll of the employee. +
-Format: `payroll n/NAME ic/NRIC pass/PASSWORD` +
-Example: `payroll n/John Doe ic/s1234567h pass/NeUeR2018`
-
 === Change priority level of employee: `setplvl`
 [NOTE]
 ====
@@ -532,17 +467,6 @@ Sets the priority level of an employee at the specified index. +
 Format: `setplvl INDEX plvl/PRIORITY_LEVEL` +
 Example: `setplvl 4 plvl/3`
 
-////
-=== Restrict access to BankAB : `restrict`  (To be implemented in v1.4 and beyond)
-[NOTE]
-====
-This operation requires those with privilege of `I.T. Unit` to perform.
-====
-Restrict access to BankAB for maintenance to all employees except superusers level 4 (Technicians).
-Anyone below superuser level 4 priority will not be able to log into the application. +
-Format: `restrict`
-////
-
 === Reset the application : `reset`
 [NOTE]
 ====
@@ -569,30 +493,42 @@ There is no need to save manually.
 
 == Command Summary
 
-•	*Help*: `help`
-•	*Check in/out working hours*: `check n/NAME ic/NRIC mode/IN-OUT`
-•	*List schedule*: `schedule INDEX`
-•	*Set schedule*: `setschedule INDEX ts/TIME_START te/TIME_END v/VENUE`
-•	*Access payroll*: `payroll n/NAME ic/NRIC pass/PASSWORD`
-•	*Edit particulars*: `edit [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS]....`
-•	*Set priority level*: `setplvl INDEX plvl/PRIORITY_LEVEL`
+=== Personal User Account
+•	*Login*: `login ic/NRIC pwd/PASSWORD`
+•	*Logout*: `logout`
+•	*Check login status*: `checkloginstatus`
+•	*Edit particulars*: `edit [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]...`
+
+=== Employee Management Database
 •	*Add employee*: `add n/NAME ic/NRIC pwd/PASSWORD p/PHONE NUMBER e/EMAIL d/DEPARTMENT a/ADDRESS [plvl/PRIORITY_LEVEL] [t/TAGS]...`
-//•	*Setting password*: `setpass n/NAME ic/s1234567h sp/PASSWORD`
-•	*Find employee*: `find KEYWORD [MORE_KEYWORDS]`
-•	*Sort address book contacts*: `sort name asc`
-•	*List available departments*: `listdepartment`
-•	*Filter departments*: `filterdepartment junior`
+•	*Deleting employee*: `delete INDEX`
+•	*Set priority level of an employee*: `setplvl INDEX plvl/PRIORITY_LEVEL`
 •	*Change department of an employee*: `setdepartment INDEX d/DEPARTMENT`
-•	*Deleting employee*: `delete INDEX [MORE_INDEX]`
-•	*Change priority level of employee*: `setplvl ic/NRIC plvl/LEVEL`
+
+=== Leave Application
 •	*Add leave application*: `leave date/DATE`
 •	*List all leave applications*: `listleave`
 •	*Filter leave applications*: `filterleave NRIC`
 •	*Delete leave application*: `deleteleave INDEX`
 •	*Approve leave application*: `approve INDEX`
 •	*Reject leave application*: `reject INDEX`
-//•	*Restrict access to BankAB*: `restrict`
+
+=== Scheduling
+•	*List schedule*: `schedule INDEX`
+•	*Set schedule*: `setschedule INDEX ts/TIME_START te/TIME_END v/VENUE`
+
+=== Filtering/Sorting
+•	*Find employee*: `find KEYWORD [MORE_KEYWORDS]`
+•	*Sort address book contacts*: `sort name asc`
+•	*List available departments*: `listdepartment`
+•	*Filter departments*: `filterdepartment junior`
+
+=== Miscellaneous
+•	*Check in/out working hours*: `check ic/NRIC pwd/PASSWORD mode/IN-OUT`
+•	*Help*: `help`
 •	*Reset the application*: `reset`
+•	*Exit application*: `exit`
+
 
 == Appendix A: List of prefixes in the application
 .List of prefixes
@@ -642,7 +578,7 @@ Department names should start with a name, and ends with 'Management'.
 | Priority Level
 | plvl/PRIORITY_LEVEL
 | Priority Level should be a number respective to the following classification: - +
-[0] I.T. Unit (HIGHEST)+
+[0] I.T. Unit (HIGHEST) +
 [1] Administrator +
 [2] Manager +
 [3] Basic (LOWEST)
@@ -653,3 +589,33 @@ Department names should start with a name, and ends with 'Management'.
 | Tag names should be alphanumeric
 | t/Admin t/Boss t/OweMeMoney
 |===
+
+
+== Appendix B: Privileges in accordance to priority level
+.Priority level and its' privileges
+|===
+|*Priority Level* |*Privileges*
+
+|BASIC (3)
+|
+- Edit your own particulars +
+- Apply for leave
+
+|MANAGER (2)
+|
+- All privileges of a BASIC Priority Level +
+- Approve/Reject/Delete leave of users with lower priority level +
+- Allow others to check in/out to/from work
+
+|ADMINISTRATOR (1)
+|
+- All privileges of a MANAGER Priority level +
+- Add and delete employees from the AddressBook +
+- Set the priority level of all employees +
+- Set Department of all employees
+
+|I.T. Unit (0)
+|
+- All privileges of a ADMINISTRATOR Priority level +
+- Reset the entire AddressBook
+|===

docs/team/hafizuddin.adoc

@@ -50,12 +50,12 @@ _{you can add/remove categories in the list above}_
 |_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
 |===
 
-include::../UserGuide.adoc[tag=undoredo]
+//include whatever you did here
 
 == Contributions to the Developer Guide
 
 |===
 |_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
 |===
 
-include::../DeveloperGuide.adoc[tag=undoredo]
+//include whatever you did here

docs/team/jinyao.adoc

@@ -50,12 +50,12 @@ _{you can add/remove categories in the list above}_
 |_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
 |===
 
-include::../UserGuide.adoc[tag=undoredo]
+//include whatever you did here
 
 == Contributions to the Developer Guide
 
 |===
 |_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
 |===
 
-include::../DeveloperGuide.adoc[tag=undoredo]
+//include whatever you did here

docs/team/pinjuen.adoc

@@ -50,12 +50,12 @@ _{you can add/remove categories in the list above}_
 |_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
 |===
 
-include::../UserGuide.adoc[tag=undoredo]
+//include whatever you did here
 
 == Contributions to the Developer Guide
 
 |===
 |_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
 |===
 
-include::../DeveloperGuide.adoc[tag=undoredo]
+//include whatever you did here

docs/team/woonhian.adoc

@@ -50,12 +50,12 @@ _{you can add/remove categories in the list above}_
 |_Given below are sections I contributed to the User Guide. They showcase my ability to write documentation targeting end-users._
 |===
 
-include::../UserGuide.adoc[tag=undoredo]
+//include whatever you did here
 
 == Contributions to the Developer Guide
 
 |===
 |_Given below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project._
 |===
 
-include::../DeveloperGuide.adoc[tag=undoredo]
+//include whatever you did here