Skip to content

Commit

Permalink
Updated use cases and developer guide
Browse files Browse the repository at this point in the history
  • Loading branch information
sheryew committed Oct 15, 2023
1 parent edef868 commit 90fc091
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,27 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Use Case: Viewing Employee(s)' Attributes**

**MSS**

1. User requests to view specific attributes of employee(s).
2. HR Insight shows the specific attributes of the employee(s).
Use case ends.

**Extensions**
* 1a. User provides a false attribute (Prefix).
* 1a1. HR Insight shows an error message.
* 1a2. HR Insight shows all the attributes (Prefixes) it can display for employee(s).

Use case ends.

* 1b. User didn't provide any attribute that it wants to view.
* 1b1. HR Insight shows an error message.
* 1b2. HR Insights shows all the attributes (Prefixes) it can display for employee(s).

Use case ends.

*{More to be added}*

### Non-Functional Requirements
Expand Down
17 changes: 16 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ HR Insight is a **desktop app for HR people, optimized for use via a Line Interf
- `delete 3` : Deletes the 3rd employee shown in the current list.

- `claim 2 $/-60` : Deducts $60 from the claims of the 2nd employee in the list.


- `view n/1,2 s/1,2` : View the name and salary of employees with list index of 1 & 2 respectively.

- `clear` : Deletes all employees from the database.

- `exit` : Exits the app.
Expand Down Expand Up @@ -202,6 +204,19 @@ Examples:
- `birthday` followed by `10` displays all employees who have their birthday in the month of October


### Viewing employee's details: `view`

Views employee(s)'s personal attributes.

Format: `view [n/INDEX] [a/INDEX] [e/INDEX] [e/INDEX] [s/INDEX] [b/INDEX] [d/INDEX] [dob/INDEX]`

- Gives an overview of employee(s)'s attributes.
- Minimum of one prefix is required.
- INDEX parameters can either be a single digit or digits separated by ",".

- Examples:
- `view` followed by `s/1,2` displays employees with list's index of 1 and 2 respective salaries.


### Saving the data

Expand Down

0 comments on commit 90fc091

Please sign in to comment.