diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 65f6eb37cd7..5f0d83d58b1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -213,7 +213,7 @@ Field Constraints: Examples: -* `editappt 1 ad/2025-04-09 11:00` Edits the appointment date and time of the first appointment in the appointment list to `2024-04-09 11:00` +* `editappt 1 ad/2025-04-09 11:00` Edits the appointment date and time of the first appointment in the appointment list to `2025-04-09 11:00` ![add_appointment_result](images/editAppointment.png) @@ -233,9 +233,10 @@ Command Constraints: e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` Examples: -* `patient John` returns `john` and `John Doe` -* `patient alex david` returns `Alex Yeoh`, `David Li`
- ![result for 'patient alex david'](images/findAlexDavidResultPatient.png) +* `patient John David` returns `patient` with name `John Doe` and `patient` with name `David Li` +* `patient S1234` returns `patient` with `Nric` `S1234567A`, `patient` with `Nric` `S1234765Q` +* `patient 30 Jan` returns `patient` with `DoB` `30 January 1990`, `patient` with `DoB` `30 January 2001`
+ ![result for 'patient alex david'](images/findPatient.png) ### Querying persons by name : `doctor` @@ -254,12 +255,13 @@ Command Constraints: e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang` Examples: -* `doctor John` returns `john` and `John Doe` -* `doctor alex david` returns `Alex Yeoh`, `David Li`
- ![result for 'doctor alex david'](images/findAlexDavidResultDoctor.png) +* `doctor John David` returns `doctor` with name `John Doe` and `doctor` with name `David Li` +* `doctor S1234` returns `doctor` with `Nric` `S1234567A`, `doctor` with `Nric` `S1234765Q` +* `doctor 30 Jan` returns `doctor` with `DoB` `30 January 1990`, `doctor` with `DoB` `30 January 2001`
+ ![result for 'doctor alex david'](images/findDoctor.png) -### Querying appointments by NRIC : `apptforpatient` +### Querying appointments by Patient's NRIC : `apptforpatient` Format: `apptforpatient KEYWORD [MORE_KEYWORDS]` @@ -272,16 +274,16 @@ match appointments that involve `S1234562A` and `S1234561A`. * Appointments with `Patient`s whose NRICs match at least one keyword will be returned (i.e. `OR` search). Example: -* `apptforpatient s0123456a` returns all `Appointment` object(s) that `Patient` with NRIC `S0123456A` is involved in. +* `apptforpatient s0123456a` returns all `Appointment` entries that `Patient` with `Nric` `S0123456A` is involved in. -* Initial State (All `Appointment`s listed) +* All `Appointment`s listed ![result for 'list'](images/findAppointmentInitialPatient.png) -* After Querying (Only `Appointment`s with `Patient` of NRIC `S0123456A`) +* Only `Appointment`s with `Patient` of `Nric` `S0123456A` ![result for 'apptforpatient S0123456A'](images/findAppointmentResultPatient.png) -### Querying appointments by NRIC : `apptfordoctor` +### Querying appointments by Doctor's NRIC : `apptfordoctor` Format: `apptfordoctor KEYWORD [MORE_KEYWORDS]` @@ -297,10 +299,10 @@ match appointments that involve `S1234562A` and `S1234561A`. Example: * `apptfordoctor s1234561a` returns all `Appointment` object(s) that `Doctor` with NRIC `S1234561A` is involved in. -* Initial State (All `Appointment`s listed) -![result for 'apptfordoctor S1234561A'](images/findAppointmentInitialDoctor.png) +* All `Appointment`s listed +![result for 'list'](images/findAppointmentInitialDoctor.png) -* After Querying (Only `Appointment`s with `Doctor` of NRIC `S1234561A`) +* Only `Appointment`s with `Doctor` of `Nric` `S1234561A` ![result for 'apptfordoctor S1234561A'](images/findAppointmentResultDoctor.png) @@ -317,7 +319,7 @@ Examples: * `patient John` followed by `delete 1` deletes the 1st patient in the results of the `patient` search command. * `doctor Steve` followed by `delete 2` deletes the 2nd doctor in the results of the `doctor` search command. -![result for 'delete 1'](images/deletePatient.png) +![result for 'delete 1'](images/deletePerson.png) ### Deleting appointment : `deleteappt` @@ -335,9 +337,9 @@ Examples: * `apptfordoctor S1234567B` followed by `deleteappt 2` deletes the 2nd appointment in the results of the `apptfordoctor` search command. Visual Guide -* Initial State (All appointments listed after running `list`) +* All appointments listed after running `list` ![result for 'list'](images/deleteApptInitialState.png) -* Final State (After running `deleteappt` with `Index` of `1`) +* After running `deleteappt` with `Index` of `1` ![result for 'deleteappt 1'](images/deleteApptFinalState.png) ### Clearing all entries : `clear` diff --git a/docs/images/addAppointment.png b/docs/images/addAppointment.png index c7e71975d8b..87752eeb579 100644 Binary files a/docs/images/addAppointment.png and b/docs/images/addAppointment.png differ diff --git a/docs/images/addDoctor.png b/docs/images/addDoctor.png index 0b647b0a014..a775b0ba894 100644 Binary files a/docs/images/addDoctor.png and b/docs/images/addDoctor.png differ diff --git a/docs/images/addPatient.png b/docs/images/addPatient.png index 99118a35ec5..01c07a2fff4 100644 Binary files a/docs/images/addPatient.png and b/docs/images/addPatient.png differ diff --git a/docs/images/deleteApptFinalState.png b/docs/images/deleteApptFinalState.png index ba87c3837f0..a08b804ff3e 100644 Binary files a/docs/images/deleteApptFinalState.png and b/docs/images/deleteApptFinalState.png differ diff --git a/docs/images/deleteApptInitialState.png b/docs/images/deleteApptInitialState.png index 07fcfa3e313..69699e07a77 100644 Binary files a/docs/images/deleteApptInitialState.png and b/docs/images/deleteApptInitialState.png differ diff --git a/docs/images/deletePatient.png b/docs/images/deletePatient.png deleted file mode 100644 index 100965baca3..00000000000 Binary files a/docs/images/deletePatient.png and /dev/null differ diff --git a/docs/images/deletePerson.png b/docs/images/deletePerson.png new file mode 100644 index 00000000000..b9261670c20 Binary files /dev/null and b/docs/images/deletePerson.png differ diff --git a/docs/images/editAppointment.png b/docs/images/editAppointment.png index ec30d4b353c..f5bcdf51f6c 100644 Binary files a/docs/images/editAppointment.png and b/docs/images/editAppointment.png differ diff --git a/docs/images/editPerson.png b/docs/images/editPerson.png index 226198acea9..189b2db43eb 100644 Binary files a/docs/images/editPerson.png and b/docs/images/editPerson.png differ diff --git a/docs/images/findAppointmentInitialDoctor.png b/docs/images/findAppointmentInitialDoctor.png index e59f1223575..5b641f46782 100644 Binary files a/docs/images/findAppointmentInitialDoctor.png and b/docs/images/findAppointmentInitialDoctor.png differ diff --git a/docs/images/findAppointmentInitialPatient.png b/docs/images/findAppointmentInitialPatient.png index 59ed0e3d5b2..6cd9b331957 100644 Binary files a/docs/images/findAppointmentInitialPatient.png and b/docs/images/findAppointmentInitialPatient.png differ diff --git a/docs/images/findAppointmentResultDoctor.png b/docs/images/findAppointmentResultDoctor.png index 96047f478d4..26aeabd94d4 100644 Binary files a/docs/images/findAppointmentResultDoctor.png and b/docs/images/findAppointmentResultDoctor.png differ diff --git a/docs/images/findAppointmentResultPatient.png b/docs/images/findAppointmentResultPatient.png index c36b0c0752b..62b2f9b43a1 100644 Binary files a/docs/images/findAppointmentResultPatient.png and b/docs/images/findAppointmentResultPatient.png differ diff --git a/docs/images/findDoctor.png b/docs/images/findDoctor.png new file mode 100644 index 00000000000..1f9d194c1ea Binary files /dev/null and b/docs/images/findDoctor.png differ diff --git a/docs/images/findPatient.png b/docs/images/findPatient.png new file mode 100644 index 00000000000..eaaf0fb3118 Binary files /dev/null and b/docs/images/findPatient.png differ