From 48dc55ffa983e10959e1d63cefc42c2b450ab107 Mon Sep 17 00:00:00 2001 From: YangHeng Tang Date: Tue, 14 Nov 2023 11:13:30 +0800 Subject: [PATCH 1/2] Resolve merge conflict and add page break --- docs/UserGuide.md | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 4a76af9337a..915ceb5e7a0 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -53,6 +53,8 @@ Here are some common terms that are used throughout this user guide | Parameter | The additional information you provide for the instruction you intend to enter | | Appointment | A scheduled medical consultation between the patient and the doctor | +
+ ## 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 to be overwhelming. @@ -93,6 +95,8 @@ return 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) @@ -253,6 +257,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. @@ -288,6 +294,8 @@ edit_p 4 p\81453894 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. @@ -328,6 +336,8 @@ If patient is deleted, the patient's appointments will also be deleted. Back to [Patient Management Features](#patient-management-features). +
+ ### Adding a medical condition to a patient : `add_tag_p` Allow you to add a medical condition to a specified patient in the system. @@ -363,6 +373,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 patients are on. @@ -430,7 +442,9 @@ add_d n\John Doe ic\T0212385J Back to [Doctor Management Features](#doctor-management-features). -### Listing all doctor : `list_d` +
+ +### Listing all doctors : `list_d` Allows you to list all the doctors in the system. @@ -452,12 +466,16 @@ Allows you to view details, such as basic information, specialisation and remark * 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 the image of a successful result that you should have encountered. +
+ +Below is an example of a successful view command call. ![ViewDoctorMainWindow](images/view-doctor.jpg) 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. @@ -492,6 +510,8 @@ edit_d 4 ic\T0212385J Back to [Doctor Management Features](#doctor-management-features). +
+ ### Locating doctors by name : `find_d` Allow you to locate doctors whose name contains any of the given keywords. @@ -531,6 +551,8 @@ If doctor is being removed, the appointments of the doctor's will also be delete Back to [Doctor Management Features](#doctor-management-features). +
+ ### Adding a specialisation to a doctor : `add_tag_d` Allows you to add a specialisation for a specified doctor in the system. @@ -566,6 +588,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. @@ -630,6 +654,8 @@ Allows you to either display all the appointments in the system, or the list of 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. @@ -660,7 +686,10 @@ edit_a 4 pic\S9923334G Back to [Appointment Management Features](#appointment-management-features). -### Viewing an appointment : `view_a` + +
+ +### 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. @@ -679,6 +708,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. @@ -709,6 +740,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. @@ -791,6 +824,8 @@ MediConnect data are saved in the hard disk automatically after any command that 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. From b9f8ffb7d11167cedef622aa3770e9a1afdeaac6 Mon Sep 17 00:00:00 2001 From: YangHeng Tang Date: Tue, 14 Nov 2023 11:16:26 +0800 Subject: [PATCH 2/2] Remove extra empty line --- docs/UserGuide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 34f82844d17..33f6077315c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -761,7 +761,6 @@ 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`