diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c462fba0c13..33f6077315c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -55,6 +55,8 @@ Here are some common terms used throughout this user guide. | MAX_INT | Integer value 2147483647 | | Command Terminal | A window into which users can type commands that are then executed by their computer's operating system | +
+ ## Navigating this user guide As this guide aims to be as comprehensive as possible, you might find the amount of information in this user guide overwhelming. @@ -95,6 +97,8 @@ Back to [Table of Contents](#table-of-contents). The commands you give should look similar to what is shown below: ![Terminal](images/terminalcommand.png) +
+ A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.
![Ui](images/Ui.png) @@ -273,6 +277,8 @@ Below is an example of a successful view command call. Back to [Patient Management Features](#patient-management-features). +
+ ### Editing a patient : `edit_p` Allows you to edit an existing patient in the system. This is useful to correct any mistakes made when adding or updating a patient. @@ -311,6 +317,8 @@ Edited Patient: Jonathan Reese; Phone: 81453894; NRIC: S8712461K Back to [Patient Management Features](#patient-management-features). +
+ ### Locating patients by name : `find_p` Allows you to find patients whose name contains any of the given keywords. @@ -352,6 +360,8 @@ If a patient is removed, the appointments of the patient will be deleted too! Back to [Patient Management Features](#patient-management-features). +
+ ### Adding a medical condition to a patient : `add_tag_p` Allows you to add a medical condition to a specified patient in the system. @@ -389,6 +399,8 @@ Allows you to delete a medical condition from a specified patient in the system. Back to [Patient Management Features](#patient-management-features). +
+ ### Editing the remark of a patient : `remark_p` Allows you to edit the remark of a specified patient in the system. The patient's remark can be used to store temporary information such as family health history and current medications/treatments the patient is on. @@ -461,6 +473,8 @@ New doctor added: John Doe; Nric: T0212385J Back to [Doctor Management Features](#doctor-management-features). +
+ ### Listing all doctors : `list_d` Allows you to list all the doctors in the system. @@ -488,12 +502,16 @@ Allows you to view details, such as basic information, specialisation, and remar * Entering `list_d` followed by `view_d 2` shows the details of the 2nd doctor in the doctor list. * Entering `find_d Jonathan` followed by `view_d 1` shows the details of the 1st doctor in the resultant doctor list of the `find_d` command. +
+ Below is an example of a successful view command call. ![ViewDoctorMainWindow](images/view-doctor.png) Back to [Doctor Management Features](#doctor-management-features). +
+ ### Editing a doctor : `edit_d` Allows you to edit an existing doctor in the system. This is useful to correct any mistakes made when adding or updating a doctor. @@ -531,6 +549,8 @@ Edited Doctor: Joe Ng; Nric: T0212385J Back to [Doctor Management Features](#doctor-management-features). +
+ ### Locating doctors by name : `find_d` Allows you to locate doctors whose name contains any of the given keywords. @@ -571,6 +591,8 @@ If a doctor is removed, the appointments of the doctor will be deleted too! Back to [Doctor Management Features](#doctor-management-features). +
+ ### Adding a specialisation to a doctor : `add_tag_d` Allows you to add a specialisation to a specified doctor in the system. @@ -608,6 +630,8 @@ Allows you to delete a specialisation from a specific doctor in the system. Back to [Doctor Management Features](#doctor-management-features). +
+ ### Editing the remark of a doctor : `remark_d` Allows you to edit the remark of a specified doctor in the system. The doctor's remark is usually used to indicate the doctor's availability. @@ -698,6 +722,8 @@ Allows you to either display all the appointments in the system or the list of a Back to [Appointment Management Features](#appointment-management-features). +
+ ### Editing an appointment : `edit_a` Allows you to edit an existing appointment in the system. This is useful to correct any mistakes made when adding or updating an appointment. @@ -735,6 +761,8 @@ If you edit the patient or doctor NRIC of an appointment, ensure that there exis Back to [Appointment Management Features](#appointment-management-features). +
+ ### Viewing details of an appointment : `view_a` Allows you to view details, such as basic information, prescription given, and remark, of a specific appointment in the system. @@ -759,6 +787,8 @@ Below is the image of a successful result that you should have encountered. Back to [Appointment Management Features](#appointment-management-features). +
+ ### Deleting an appointment : `delete_a` Allows you to delete the specified appointment from the system. @@ -793,6 +823,8 @@ Allows you to add a prescription for an appointment in the system. Back to [Appointment Management Features](#appointment-management-features). +
+ ### Deleting a prescription from an appointment : `delete_tag_a` Allows you to delete a prescription from an appointment in the system. @@ -872,6 +904,8 @@ MediConnect data are saved in the hard disk automatically after any command. The Back to [General Features](#general-features). +
+ ### Editing the data file MediConnect data are saved automatically as a JSON file `[JAR file location]/data/database.json`. Advanced users are welcome to update data directly by editing that data file.