Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/AY2324S1-CS2103T-T12-4/tp
Browse files Browse the repository at this point in the history
…into branch-documentation
  • Loading branch information
Darren159 committed Nov 14, 2023
2 parents 468111e + 14e8bf5 commit 8aa1c88
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 30 deletions.
57 changes: 31 additions & 26 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default.md
title: "User Guide"
pageNav: 3
pageNav: 4
---

# User Guide
Expand Down Expand Up @@ -42,26 +42,30 @@ With MedBook, experience a new level of convenience and control:
- [MedBook Tutorial](#medbook-tutorial)
- [Features](#features)
- [Parameters](#parameters)
- [Viewing help](#viewing-help--help)
- [Adding a patient](#adding-a-patient-addpatient)
- [Adding a medical record](#adding-a-medical-record-addrecord)
- [Adding an appointment](#adding-an-appointment-addappointment)
- [Listing all patients](#listing-all-patients-list)
- [Viewing patient medical records](#viewing-patient-medical-records-view)
- [Viewing appointments](#viewing-appointments-viewappointment)
- [Editing a patient](#editing-a-patient-editpatient)
- [Editing a medical record](#editing-a-medical-record-editrecord)
- [Locating patients by keywords](#locating-patients-by-keywords-search)
- [Locating medical records by keywords](#locating-medical-records-by-keywords-searchrecord)
- [Deleting a patient](#deleting-a-patient-delete)
- [Deleting a medical record](#deleting-a-medical-record-deleterecord)
- [Deleting an appointment](#deleting-an-appointment-deleteappointment)
- [Pinning a patient](#pinning-a-patient-pin)
- [Unpinning a patient](#unpinning-a-patient-unpin)
- [Attaching files to a patient's medical record](#attaching-files-to-a-patients-medical-record)
- [Exiting the program](#exiting-the-program-exit)
- [Saving the data](#saving-the-data)
- [Editing the data file](#editing-the-data-file)
- [Patient Features](#patient-features)
- [Adding a patient](#adding-a-patient-addpatient)
- [Editing a patient](#editing-a-patient-editpatient)
- [Deleting a patient](#deleting-a-patient-delete)
- [Locating patients by keywords](#locating-patients-by-keywords-search)
- [Listing all patients](#listing-all-patients-list)
- [Pinning a patient](#pinning-a-patient-pin)
- [Unpinning a patient](#unpinning-a-patient-unpin)
- [Medical Record Features](#medical-record-features)
- [Adding a medical record](#adding-a-medical-record-addrecord)
- [Viewing patient medical records](#viewing-patient-medical-records-view)
- [Editing a medical record](#editing-a-medical-record-editrecord)
- [Deleting a medical record](#deleting-a-medical-record-deleterecord)
- [Locating medical records by keywords](#locating-medical-records-by-keywords-searchrecord)
- [Attaching files to a patient's medical record](#attaching-files-to-a-patient-s-medical-record)
- [Appointment Features](#appointment-features)
- [Adding an appointment](#adding-an-appointment-addappointment)
- [Deleting an appointment](#deleting-an-appointment-deleteappointment)
- [Viewing appointments](#viewing-appointments-viewappointment)
- [General Features](#general-features)
- [Viewing help](#viewing-help-help)
- [Exiting the program](#exiting-the-program-exit)
- [Saving the data](#saving-the-data)
- [Editing the data file](#editing-the-data-file)
- [FAQ](#faq)
- [Known Issues](#known-issues)
- [Command Summary](#command-summary)
Expand Down Expand Up @@ -336,7 +340,7 @@ The **domain** name must: <br>

---

### Patient features
### Patient Features

#### Adding a patient: `addpatient`

Expand Down Expand Up @@ -376,7 +380,8 @@ Format: `editpatient PATIENTID PREFIX/NEWVALUE...`
- Edits the details of the patient with the corresponding `PATIENTID`. <br>

- Acceptable fields: `NAME`, `EMAIL`, `PHONE`, `GENDER`, `AGE`, `BLOODTYPE`, `ALLERGY`. <br>
<box type="info">

<box type="info">

**Note**: `NRIC` cannot be edited.

Expand Down Expand Up @@ -534,7 +539,7 @@ Examples:

---

### Medical Record features
### Medical Record Features

#### Adding a medical record: `addrecord`

Expand Down Expand Up @@ -704,7 +709,7 @@ Screenshots:

---

### Appointment features
### Appointment Features

#### Adding an appointment: `addappointment`

Expand Down Expand Up @@ -765,7 +770,7 @@ Format: `viewappointment`

---

### General features
### General Features

#### Viewing help : `help`

Expand Down
8 changes: 4 additions & 4 deletions docs/team/hjoneweek.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ title: "Hanjoo's Project Portfolio Page"
- Created the `AddRecordCommandParser` class and the `AddRecordCommand` class to execute the `addrecord` command.

- **New Feature 2**: Search Record Feature [#86](https://github.com/AY2324S1-CS2103T-T12-4/tp/pull/86)
- Another essential feature that allows doctors to search for the past records of the patient that they are currently viewing using keywords.
- Another essential feature that allows doctors to use keywords to search for the past records of the patient that they are currently viewing.
- Created the `RecordContainsKeywordPredicate` class, `FindRecordCommandParser` class, and the `FindRecordCommand` class to execute the `searchrecord` command.

- **New Feature 3** Delete Record Feature [#88](https://github.com/AY2324S1-CS2103T-T12-4/tp/pull/88)
- Allows doctors to delete records of patients if necessary
- Allows doctors to delete records of patients if necessary.
- Created the `DeleteRecordCommandParser` class and the `DeleteRecordCommand` class to execute the `deleterecord` command.

- **Documentation**
- User Guide
- Added new sections explaining how to use the newly implemented features and commands, which are `addrecord`, `searchrecord`, and `deleterecord` command.
- Modified `addpatient` command (originally `addperson` command) section according to the updated attributes of the patient.
- Modified `addpatient` command (which was originally `add` command) section according to the updated attributes of the patient.
- Reviewed the User Guide altogether as a team.

- Developer Guide
- Added the **Record Feature** section (except for the implementation details of `editrecord` command).
- Added the **Record Feature** section (except for the implementation details of the `editrecord` command).
- Created the sequence diagrams of the executions of the `addrecord`, `searchrecord`, `deleterecord`, and `addpatient` commands.
- Created the class diagrams of the `Record`, and `Person` classes.
- Updated the class diagrams for `UI`, `Storage`, and `Model` components of MedBook.
Expand Down

0 comments on commit 8aa1c88

Please sign in to comment.