diff --git a/docs/UserGuide.md b/docs/UserGuide.md index acbaed0c33f..848e8a1e708 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -19,6 +19,7 @@ The purpose of this user guide document is to provide staff with a clear underst 💡**Tip**:
Messages in this format include information that may be useful to the user. +
# Table of Contents: @@ -47,6 +48,8 @@ The purpose of this user guide document is to provide staff with a clear underst -------------------------------------------------------------------------------------------------------------------- +
+ ## Setup 1. Ensure you have Java `11` or above installed in your Computer. @@ -87,11 +90,14 @@ Note: HospiSearch is compatible with Windows, MacOS and Ubuntu. [return to table of contents](#table-of-contents) +
+ ## GUI Information ![DefinedGUI](images/DefinedGUI.png) -------------------------------------------------------------------------------------------------------------------- +
## Command Prefixes @@ -112,6 +118,8 @@ Note: HospiSearch is compatible with Windows, MacOS and Ubuntu. [return to table of contents](#table-of-contents) +
+ ## Features ### Notes: @@ -139,7 +147,7 @@ executed in lower case. E.g., `find` is valid, but `FIND` or `FinD` is considere not need to be in lower case. - +
### Adding a patient record: `add` @@ -165,6 +173,8 @@ Examples: Above is the execution result of the input `add i/S1234567H n/Cedric Pei dob/03/04/2002 p/84655284 a/PGPR g/Male d/NKDA ad/Shannon t/Diabetic m/Lantus m/Soliqua`. +
+ ### Editing a patient record: `edit` In a situation when you want to update a patient's phone number or other particulars this feature can allow you to do so. @@ -186,6 +196,8 @@ Examples: Above is the execution result of the input `edit 7 i/G0000000A`. +
+ ### Viewing a patient detailed particulars: `view` In a situation when you want to obtain in depth information of a particular patient which is not available in the patient records list, you can use this feature to do so. @@ -203,6 +215,8 @@ Examples: Above is the execution result of the input `view i/S1234567H`. +
+ ### Deleting a patient record: `delete` In a situation when you want to delete a patient from the patient records list due to death and the specified retention period is over, you can use this feature to do so. @@ -217,6 +231,8 @@ Examples: * `delete i/S1234567A` deletes the patient with NRIC S1234567A from patient records system. +
+ ### Filtering patients by attribute: `find` You can search for patients based on their name, age, medical condition, or any other relevant criteria @@ -253,6 +269,8 @@ Examples (The following results are based of the sample data provided): Above is the execution result of the input `find ad/Alex`. +
+ ### Listing all patients: `list` You can use this feature to get a list of all patients in the records. @@ -270,6 +288,7 @@ that you have loaded. Above is the execution result of the input `list`. +
### Backing up patient records: `backup` @@ -297,6 +316,8 @@ Examples: Above is the execution result of the input `backup 1`. +
+ ### Loading data: `load` In the event of a data loss, you can load the backup data from a specified slot represented by an index. @@ -310,6 +331,7 @@ Example: * `load 3` loads the data from the 3rd slot. +
### Viewing backup data: `viewbackups` @@ -324,6 +346,8 @@ Format: `viewbackups` Above is the execution result of the input `viewbackups`. +
+ ### Deleting backup data: `deletebackup` You can use this feature to delete the backup data from a specified slot represented by an index. @@ -338,6 +362,8 @@ Example: * `deletebackup 3` deletes the data from the 3rd slot. +
+ ### Clearing all data: `clear` Purges all data from the database. @@ -352,6 +378,8 @@ Format: `clear` Above is the execution result of the input `clear`. +
+ ### Undoing previous command: `undo` In the event that your previous change was a mistake, you can use this feature to revert the patient records to the state before the previous command was executed. @@ -370,6 +398,8 @@ Changing the name of a patient above `edit 6 n/John Balakrishnan` (Previously Ro And above is the execution of `undo` +
+ ### Redoing previous undo: `redo` In the event that you accidentally removed the changes you made, you can use this feature to revert the patient records to the state before the previous undo was executed. @@ -383,6 +413,7 @@ Format: `redo` ![Redo](images/command_result/Redo.png) Following the above example for `undo`, `redo` would subsequently change the name of the patient again. +
### Switching to light mode: `light` @@ -394,13 +425,14 @@ Format: `light` Above is the execution result of the input `light`. +
+ ### Switching to dark mode: `dark` Switches the GUI to dark mode. Format: `dark` - 💡**Tip**:
The default GUI is light mode. Use these commands and see which is your preferred GUI! @@ -408,6 +440,8 @@ Format: `dark` Above is the execution result of the input `dark`. +
+ ### Viewing help : `help` In case you need help navigating HospiSearch, you can use this feature which lists out all the commands available, along with a brief description. @@ -422,6 +456,8 @@ Above is the view of help window after the input `help`. -------------------------------------------------------------------------------------------------------------------- [return to table of contents](#table-of-contents) +
+ ## FAQ **Q**: How do I transfer my data to another Computer?
@@ -433,6 +469,8 @@ Above is the view of help window after the input `help`. -------------------------------------------------------------------------------------------------------------------- [return to table of contents](#table-of-contents) +
+ ## Command summary | Action | Format, Examples |