Skip to content

Commit

Permalink
Merge pull request #396 from yentheng0110/YenTheng-FinalCheckForUG
Browse files Browse the repository at this point in the history 
Shorten Overview of PPP
  • Loading branch information
@yentheng0110
yentheng0110 authored Nov 11, 2024
2 parents 435eaa7 + 0fb6a44 commit e1997b4
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 31 deletions.
48 changes: 23 additions & 25 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Format: `help`
| | TIME format: HH:mm | m/Paracetamol,Ibuprofen |
+-------------+---------------------------------------+---------------------------------+
| Edit Visit | editVisit ic/NRIC | editVisit ic/S7209876Y |
| | v/VISIT_DATE_AND_TIME | v/06-11-2024 14:00 |
| | v/VISIT_DATE_AND_TIME | v/06-11-2024 14:00 |
| | [newDate/NEW_DATE] [d/DIAGNOSIS] | newDate/08-11-2024 14:00 |
| | [m/MEDICATION] | d/Asthma m/Panadol, Antibiotics |
| | DATE format: dd-mm-yyyy | |
Expand All @@ -99,12 +99,10 @@ Format: `help`
| Find | find n/NAME OR | find n/John Doe |
| | find ic/NRIC OR | find ic/S1234 |
| | find p/PHONE_NUMBER OR | find p/91234567 |
| | find d/DIAGNOSIS OR | find d/Fever |
| | find m/MEDICATION OR | find m/Panadol |
| | find ha/HOME_ADDRESS OR | find ha/NUS PGPR |
| | find dob/DATE_OF_BIRTH OR | find dob/31-01-1990 |
| | find al/ALLERGY OR | find al/Peanuts |
| | find find s/SEX OR | find find s/Female |
| | find s/SEX OR | find find s/Female |
| | find mh/MEDICAL_HISTORY | find mh/Diabetes |
+-------------+---------------------------------------+---------------------------------+
| Delete | delete NRIC | delete S9534567A |
Expand All @@ -114,7 +112,7 @@ Format: `help`
| | DATE format: dd-mm-yyyy | |
| | TIME format: HH:mm | |
+-------------+---------------------------------------+---------------------------------+
| List | listAppointments | list |
| List | listAppointments | listAppointments |
| Appointment | | |
+-------------+---------------------------------------+---------------------------------+
| Find | findAppointment n/NAME OR | findAppointment n/John Doe |
Expand Down Expand Up @@ -635,23 +633,23 @@ Reason : It could be possible that the two patients arrived at the clinic with e

---

## Command Summary

| Action | Format | Example |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Help | `help` | `help` |
| Add patient record | `add n/NAME ic/NRIC [p/PHONE_NUMBER] [d/DIAGNOSIS] [m/MEDICATION] [ha/HOME_ADDRESS] [dob/DATE_OF_BIRTH] v/VISIT_DATE_TIME [al/ALLERGY] [s/SEX] [mh/MEDICALHISTORY]` | `add n/James Ho ic/S9534567A p/91234567 d/Asthma m/Albuterol ha/NUS-PGPR dob/31-01-1990 v/21-10-2024 15:48 al/Pollen s/Female mh/Diabetes` |
| Edit patient record | `edit ic/NRIC /to [n/NAME] [newic/NEW_NRIC] [p/PHONE_NUMBER] [ha/HOME_ADDRESS] [dob/DATE_OF_BIRTH] [al/ALLERGY] [s/SEX] [mh/MEDICAL_HISTORY]` | `edit ic/S9534567A /to p/80976890 mh/Diabetes, Hypertension ` |
| Add Visit | `addVisit ic/NRIC v/VISIT_DATE_TIME [d/DIAGNOSIS] [m/MEDICATION]`<br>DATE format: `dd-mm-yyyy`<br>TIME format: `HH:mm` | `addVisit ic/S9534567A v/21-10-2024 15:48 d/Fever,Headache,Flu m/Paracetamol,Ibuprofen` |
| Edit Visit | `editVisit ic/NRIC v/VISIT_DATE_AND_TIME [newDate/NEW_DATE] [d/DIAGNOSIS] [m/MEDICATION]`<br>DATE format: `dd-mm-yyyy`<br>TIME format: `HH:mm` | `editVisit ic/S7209876Y v/06-11-2024 14:00 d/Asthma m/Panadol, Antibiotics` |
| List | `list` | `list` |
| Find | `find n/NAME` OR<br>`find ic/NRIC` OR<br>`find p/PHONE_NUMBER` OR<br>`find d/DIAGNOSIS` OR<br>`find m/MEDICATION` OR<br>`find ha/HOME_ADDRESS` OR<br>`find dob/DATE_OF_BIRTH` OR<br>`find al/ALLERGY` OR<br>`find s/SEX` OR<br>`find mh/MEDICAL_HISTORY` | `find n/John Doe`<br>`find ic/S1234`<br>`find p/91234567`<br>`find d/Fever`<br>`find m/Panadol`<br>`find ha/NUS PGPR`<br>`find dob/31-01-1990`<br>`find al/Peanuts`<br>`find s/Female`<br>`find mh/Diabetes` |
| Delete | `delete NRIC` | `delete S9534567A` |
| Add Appointment | `appointment n/NAME ic/NRIC date/DATE time/TIME`<br>DATE format: `dd-mm-yyyy`<br>TIME format: `HH:mm` | `appointment n/James Ho ic/S9534567A date/01-04-2025 time/12:00` |
| List Appointment | `listAppointments` | `listAppointments` |
| Find Appointment | `findAppointment n/NAME` OR<br>`findAppointment ic/NRIC` OR<br>`findAppointment date/DATE` OR<br>`findAppointment time/TIME`<br>DATE format: `dd-mm-yyyy`<br>TIME format: `HH:mm` | `findAppointment n/John Doe`<br>`findAppointment ic/S1234`<br>`findAppointment date/01-04-2025`<br>`findAppointment time/12:00` |
| Delete Appointment | `deleteAppointment NRIC date/DATE time/TIME`<br>DATE format: `dd-mm-yyyy`<br>TIME format: `HH:mm` | `deleteAppointment S9534567A date/01-04-2025 time/12:00` |
| Find Visits | `findVisit NRIC` | `findVisit S9534567A` |
| Find Diagnosis | `findDiagnosis diagnosis` | `findDiagnosis fever` |
| Find Medication | `findMedication medication` | `findMedication Panadol` |
| Exit | `exit` | `exit` |
## Command Summary

| Action | Format | Example |
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Help | `help` | `help` |
| Add patient record | `add n/NAME ic/NRIC [p/PHONE_NUMBER] [d/DIAGNOSIS] [m/MEDICATION] [ha/HOME_ADDRESS] [dob/DATE_OF_BIRTH] v/VISIT_DATE_TIME [al/ALLERGY] [s/SEX] [mh/MEDICALHISTORY]` | `add n/James Ho ic/S9534567A p/91234567 d/Asthma m/Albuterol ha/NUS-PGPR dob/31-01-1990 v/21-10-2024 15:48 al/Pollen s/Female mh/Diabetes` |
| Edit patient record | `edit ic/NRIC /to [n/NAME] [newic/NEW_NRIC] [p/PHONE_NUMBER] [ha/HOME_ADDRESS] [dob/DATE_OF_BIRTH] [al/ALLERGY] [s/SEX] [mh/MEDICAL_HISTORY]` | `edit ic/S9534567A /to p/80976890 mh/Diabetes, Hypertension ` |
| Add Visit | `addVisit ic/NRIC v/VISIT_DATE_TIME [d/DIAGNOSIS] [m/MEDICATION]`<br>DATE format: `dd-MM-yyyy`<br>TIME format: `HH:mm` | `addVisit ic/S9534567A v/21-10-2024 15:48 d/Fever,Headache,Flu m/Paracetamol,Ibuprofen` |
| Edit Visit | `editVisit ic/NRIC v/VISIT_DATE_TIME [newDate/NEW_DATE] [d/DIAGNOSIS] [m/MEDICATION]`<br>DATE format: `dd-MM-yyyy`<br>TIME format: `HH:mm` | `editVisit ic/S7209876Y v/06-11-2024 14:00 d/Asthma m/Panadol, Antibiotics` |
| List | `list` | `list` |
| Find | `find n/NAME` OR<br>`find ic/NRIC` OR<br>`find p/PHONE_NUMBER` OR<br>`find ha/HOME_ADDRESS` OR<br>`find dob/DATE_OF_BIRTH` OR<br>`find al/ALLERGY` OR<br>`find s/SEX` OR<br>`find mh/MEDICAL_HISTORY` | `find n/John Doe`<br>`find ic/S9234567A`<br>`find p/91234567`<br>`find ha/NUS PGPR`<br>`find dob/31-01-1990`<br>`find al/Peanuts`<br>`find s/Female`<br>`find mh/Diabetes` |
| Delete | `delete NRIC` | `delete S9534567A` |
| Add Appointment | `appointment n/NAME ic/NRIC date/DATE time/TIME`<br>DATE format: `dd-MM-yyyy`<br>TIME format: `HH:mm` | `appointment n/James Ho ic/S9534567A date/01-04-2025 time/12:00` |
| List Appointment | `listAppointments` | `listAppointments` |
| Find Appointment | `findAppointment n/NAME` OR<br>`findAppointment ic/NRIC` OR<br>`findAppointment date/DATE` OR<br>`findAppointment time/TIME`<br>DATE format: `dd-MM-yyyy`<br>TIME format: `HH:mm` | `findAppointment n/John Doe`<br>`findAppointment ic/S9234567A`<br>`findAppointment date/01-04-2025`<br>`findAppointment time/12:00` |
| Delete Appointment | `deleteAppointment NRIC date/DATE time/TIME`<br>DATE format: `dd-MM-yyyy`<br>TIME format: `HH:mm` | `deleteAppointment S9534567A date/01-04-2025 time/12:00` |
| Find Visits | `findVisit NRIC` | `findVisit S9534567A` |
| Find Diagnosis | `findDiagnosis diagnosis` | `findDiagnosis fever` |
| Find Medication | `findMedication medication` | `findMedication Panadol` |
| Exit | `exit` | `exit` |
11 changes: 5 additions & 6 deletions docs/team/yentheng0110.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Wong Yen Theng's Project Portfolio Page

## Overview
BookBob is a desktop application tailored for Dr Bob's private General Practitioner clinic. BookBob helps
streamline clinic management by storing and retrieving patient information, including names, NRICs, genders, dates of
birth, phone numbers, home addresses, allergies, medical histories and detailed visit records (visit dates and times,
diagnoses and prescribed medications). BookBob also assists Dr Bob in staying organised by tracking daily appointments
and sending reminders each morning. Optimised for a Command Line Interface (CLI), BookBob enables efficient management
of patient information and appointment scheduling.
BookBob is a Command Line Interface (CLI) desktop application tailored for Dr Bob's private General Practitioner clinic,
streamlining clinic management by storing and retrieving patient information (name, NRIC, gender, date of birth, phone
number, home address, allergies, medical histories and visit records). BookBob also helps Dr Bob manage daily
appointments by tracking them and sending morning reminders, ensuring efficient handling of patient information and
appointment scheduling.

Given below are my contributions to the project.

Expand Down

0 comments on commit e1997b4

Please sign in to comment.