From a13fa71c5da84d483e5469dbfdb6afc018b17860 Mon Sep 17 00:00:00 2001 From: remuslum <57741494+remuslum@users.noreply.github.com> Date: Sun, 12 Nov 2023 20:54:56 +0800 Subject: [PATCH] Added final changes for both guides --- docs/DeveloperGuide.md | 32 ++++++++++++++++++++------------ docs/UserGuide.md | 42 +++++++++++++++++++++++------------------- 2 files changed, 43 insertions(+), 31 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index dd1b40f070d..275f5d81dd1 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -2,9 +2,13 @@ layout: page title: Developer Guide --- - -* Table of Contents -{:toc} +## Table of Contents +- [Acknowledgements](#acknowledgements) +- [About Guide](#about-this-developer-guide) +- [Setting Up](#setting-up-getting-started) +- [Design](#design) +- [Use Cases](#appendix-a-requirements) +- [Manual Testing](#appendix-b-instructions-for-manual-testing) -------------------------------------------------------------------------------------------------------------------- @@ -307,8 +311,8 @@ The sequence diagram below shows how the `view_leave` commands execute: #### Implementation -The birthday feature extends HR Insight by allowing the user to view birthdays in a given month. -This operation is exposed in the Command Interface as `Command#BirthdayCommand`. +The birthday feature extends HR Insight by allowing the user to view birthdays in a given month. This is implemented by extracting the `Month` Class from the 'Birthday' class. +This operation is exposed in the Command Interface as `Command#BirthdayCommand`. BirthdayCommand can be invoked with or without a parameter. Given below is an example usage scenario and how the birthday mechanism behaves at each step. @@ -320,6 +324,9 @@ Step 3: After adding a few employees into the application, he/she wants to view to prepare the birthday celebrations in advance. The `birthday m/1` command will display all employees with birthdays in the month of January. +Step 4: The user now wants to view all birthdays that fall in the first quarter which includes Jan, Feb and Mar. The +`birthday m/1,2,3` command will display all employees with birthdays in the first quarter. + Step 4: The user then realises that today is the first day of a new month and he/she wants to view which employees have birthdays in the current month. The `birthday` command without providing the month will display all employees with birthdays in the current month. @@ -345,8 +352,6 @@ birthdays by month. * Cons: We must ensure that every month given by the user is valid and mention which months have no birthdays. - - ### Change Theme Feature #### Implementation @@ -662,8 +667,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli Use case ends. **Extensions** -* 1a. User provides a specific month. - * 1a1. HR Insight shows all birthdays in the specified month. +* 1a. User provides a specific month/a list of months. + * 1a1. HR Insight shows all birthdays in the specified month/s. Use case ends. @@ -683,7 +688,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli Use case ends. **Extensions** -* 1a. User provides a false attribute parameter (AKA wrong prefix). +* 1a. User provides a false attribute parameter (a.k.a. wrong prefix). * 1a1. HR Insight shows an error message. * 1a2. HR Insight shows all the attributes (Prefixes) it can display for employee(s). @@ -749,7 +754,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli Use case ends. **Extensions** -* 1a. There is no previous undone command to redo. +* 1a. There is no previous undo command to redo. * 1a1. HR Insight shows an error message that there is no command to redo. Use case ends. @@ -927,7 +932,10 @@ Prerequisites: The first employee has a claim budget of over > $500. 1. Positive Test Case: `birthday m/10`
Expected: Employees who have birthday in the month of October will be displayed. -2. Negative Test Case: `birthday m/69`
+2. Negative Test Case: `birthday m/2,3`
+ Expected: Employees who have birthday in the month of Feb and Mar will be displayed. + +3. Negative Test Case: `birthday m/69`
Expected: Error message since 69 is not a valid month. ### Viewing of employee's details diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 32260eb71ef..1cb8b0c963a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,6 +3,8 @@ layout: page title: User Guide --- +## Overview + HR Insight is a **desktop app for HR people, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). The _purpose_ of this app is to provide **HR employees** a _centralized employee management system_ to better manage all employees' details and **improve the efficiency** of their workflow. @@ -12,12 +14,13 @@ HR Insight proves to be a particularly valuable tool for professionals specializ - _Employee Benefits_ in terms of keeping count of employees' leaves and claims. - _Employee Engagement_ in terms of tracking employees' birthday. - _Administration_ in terms of keeping record of employees' details. - --- - -- Table of Contents -{:toc} - +## Table of Contents +- [Quick Start](#quick-start) +- [Features](#features) +- [FAQ](#faq) +- [Known issues](#known-issues) +- [Command summary](#command-summary) --- ## Quick start @@ -183,7 +186,7 @@ Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [s/SALARY] [d/DEPAR - Edits the employee at the specified `INDEX`. The index refers to the index number shown in the displayed employee list. The index **must be a positive integer** 1, 2, 3, …​ -- At least one of the optional fields must be provided. +- At least **1** of the optional fields must be provided. - Existing values will be updated to the input values. - Some prefixes allow for additional descriptors to accommodate a variety of input data that fits within the context of the field provided they conform to the input requirements: - For `[n/NAME]`, specific descriptors (S/O, D/O, etc.) are allowed. Ensure that the full input between the prefix and the next space or prefix is intended as part of the name. @@ -194,7 +197,7 @@ Examples: - `edit 1 n/thomas S/O anthony a/Serangoon` Edits the name and address of the 1st person to be `thomas S/O anthony` and `Serangoon` respectively. - `edit 2 s/1000 d/Sales dob/2000-01-01` Edits the salary, department and DOB of the 2nd person to be `$1000`, `Sales` and `1 January 2000` respectively. -Executing command: `edit 1 p/23423423 e/barry@example.com` +Executing command: `edit 1 p/23423423 e/barry@gmail.com` ![EditEmployeeBeforeAfter](images/EditEmployeeBefore.png) @@ -243,9 +246,9 @@ Format: `claim INDEX $/CLAIM_AMOUNT` - The `INDEX` refers to the index number shown in the displayed employee list. - The index **must be a positive integer** 1,2,3, ... -- The `CLAIM_AMOUNT` should consist of either + or - which symbolizes adding/deducting respectively followed by the amount. - - If the `CLAIM_AMOUNT` is positive, it symbolizes allocation of more funds to the user's claim budget. - - If the `CLAIM_AMOUNT` is negative, it symbolizes deduction of funds from the user's claim budget. +- The `CLAIM_AMOUNT` should consist of either + or - which symbolizes adding/deducting respectively followed by the **amount.** + - If the `CLAIM_AMOUNT` is _positive_, it symbolizes **allocation of more** funds to the user's claim budget. + - If the `CLAIM_AMOUNT` is _negative_, it symbolizes **deduction of funds** from the user's claim budget. Examples: @@ -292,8 +295,8 @@ Format: `view_leave [m/Month] [d/DEPARTMENT]` - If no one in the specified department has planned leave dates for the month, an output indicating **no employees is taking leave** is shown. Examples: -- `view_leave` displays all employees who have planned leave dates in the current year -- `view_leave m/10` displays all employees that are taking leave in October +- `view_leave` displays all employees who have planned leave dates in the current year. +- `view_leave m/10` displays all employees that are taking leave in October. - `view_leave m/10 d/IT` displays all employees in the IT department that are taking leave in October. Executing command: `view_leave m/3` @@ -316,18 +319,19 @@ Executing command: `reset_leaves` ### Viewing all birthdays in a given month : `birthday` -Views all employees’ birthday in the given months +Views all employees’ birthday in the given months. Format: `birthday [m/MONTH(s)]` -- Gives a list of **all employees** who have upcoming birthdays in the **inquired month(s)** +- Gives a list of **all employees** who have upcoming birthdays in the **inquired month(s)**. - The month argument is optional. If **no month** is provided, the birthdays in the **current month** are listed. -- If there is no birthday in the month provided, return **No employees have birthdays in this month** +- If there is no birthday in the month provided, return **No employees have birthdays in this month**. +- Months are separated using ",", e.g. to inquire the employees who have birthdays in Mar and Apr, the input is `birthday m/3,4`. Examples: -- `birthday` displays all employees who have their birthday in the current month -- `birthday m/10` displays all employees who have their birthday in the month of October -- `birthday m/1,3,4` displays all employees who have their birthday in the month of Jan, Mar and Apr +- `birthday` displays all employees who have their birthday in the current month. +- `birthday m/10` displays all employees who have their birthday in the month of October. +- `birthday m/1,3,4` displays all employees who have their birthday in the month of Jan, Mar and Apr. Executing command: `birthday m/1` @@ -342,7 +346,7 @@ Views employee(s)'s personal attribute. Format: `view [n/INDEX] [a/INDEX] [e/INDEX] [p/INDEX] [s/INDEX] [b/INDEX] [d/INDEX] [dob/INDEX]` - ViewCommand provides overview of employee(s)'s attributes. -- Maximum of one prefix is allowed. This means user can only view one attribute at a time. +- Maximum of one prefix is allowed. This means the user can only view one attribute at a time. - INDEX parameters can either be a single digit or digits separated by ",". Examples: