Skip to content

Commit

Permalink
Merge pull request #195 from AY2324S1-CS2103T-T12-4/branch-documentation
Browse files Browse the repository at this point in the history
Update UG
  • Loading branch information
hjoneweek authored Nov 14, 2023
2 parents 39e2cb7 + bd08a30 commit bc50f36
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 30 deletions.
48 changes: 24 additions & 24 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ The `delete` command deletes an existing `Person` object from MedBook.

---

### Searching a Patient
### Searching for Patients

#### Overview

Expand All @@ -274,7 +274,7 @@ The `search` command filters the list of patients using one or more keywords.
- `NameContainsKeywordsPredicate#test(Person)`
- `PersonListPanel`, `PersonCard`

#### Implementations Steps
#### Implementation Steps

1. **Parse User Input**: `FindCommandParser` checks for existence of the keyword(s) and creates an array of keywords.
2. **Create Predicate Object**: A `NameContainsKeywordsPredicate` object is instantiated during `FindCommandParser#parse(String)` and passed over to the `FindCommand`.
Expand All @@ -297,7 +297,7 @@ The `pin` command pins a patient to the **Pinned Patient List**
- `Model#setPerson(Person, Person)`, `AddressBook#setPerson(Person, Person)`, `UniquePersonList#setPerson(Person, Person)`
- `PinnedPersonListPanel`, `PersonCard`

#### Implementations Steps
#### Implementation Steps

1. **Parse User Input**: `PinCommandParser` checks for the validity of the `Person` index.
2. **Create Index Object**: An `Index` object of the `Person` is instantiated during `PinCommandParser#parse(String)` and passed over to the `PinCommand`.
Expand All @@ -320,7 +320,7 @@ The `unpin` command unpins a patient from the **Pinned Patient List**
- `Model#setPerson(Person, Person)`, `AddressBook#setPerson(Person, Person)`, `UniquePersonList#setPerson(Person, Person)`
- `PinnedPersonListPanel`, `PersonCard`

#### Implementations Steps
#### Implementation Steps

1. **Parse User Input**: `UnpinCommandParser` checks for the validity of the pinned `Person` index.
2. **Create Index Object**: An `Index` object is instantiated during `UnpinCommandParser#parse(String)` and passed over to the `UnpinCommand`.
Expand Down Expand Up @@ -454,7 +454,7 @@ The `deleterecord` command deletes an existing `Record` object from MedBook.

The `view` command displays the list of records of the patient being viewed.

#### Related class and methods
#### Related Classes and Methods

- `ViewCommandParser#parse(String)`
- `ViewCommand#execute(Model)`
Expand All @@ -472,7 +472,7 @@ The `view` command displays the list of records of the patient being viewed.

---

### Searching a Record
### Searching for Records

#### Overview

Expand All @@ -486,7 +486,7 @@ The `searchrecord` command filters the list of records of the patient being view
- `RecordContainsKeywordsPredicate#test(Record)`
- `RecordListPanel`, `RecordCard`

#### Implementations Steps
#### Implementation Steps

1. **Parse User Input**: `FindRecordCommandParser` checks for existence of the keyword(s) and creates an array of keywords.
2. **Create Predicate Object**: A `RecordContainsKeywordsPredicate` object is instantiated during `FindRecordCommandParser#parse(String)` and passed over to the `FindRecordCommand`.
Expand Down Expand Up @@ -824,7 +824,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- 2a1. MedBook shows an error message.
- 2a2. User enters new PINNEDID.
- Steps 2a1-2a2 are repeated until the PINNEDID entered is correct.
- Use Case resumes from step 3.
- Use case resumes from step 3.

---

Expand Down Expand Up @@ -940,7 +940,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- 2a1. MedBook shows an error message.
- 2a2. User enters new appointment details.
- Steps 2a1-2a2 are repeated until the appointment details entered is correct.
- Use Case resumes from step 3.
- Use case resumes from step 3.

---

Expand Down Expand Up @@ -971,7 +971,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- 3a1. MedBook shows an error message.
- 3a2. User enters new appointment ID.
- Steps 3a1-3a2 are repeated until the appointment ID entered is correct.
- Use Case resumes from step 4.
- Use case resumes from step 4.

---

Expand All @@ -982,16 +982,16 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- **Preconditions**: There is at least one record entry in the patient
- **Main Success Scenario (MSS)**:

1. User views a patient’s medical records (UC10).
2. User requests to attach a file to a record of a patient.
3. User selects a file.
4. MedBook saves the file to the medical record.<br>
Use case ends.
1. User views a patient’s medical records (UC10).
2. User requests to attach a file to a record of a patient.
3. User selects a file.
4. MedBook saves the file to the medical record.<br>
Use case ends.

- **Extension**:
- 3a. User does not choose a file.
- 3a1. MedBook displays an error message.
- Use case ends.
- 3a. User does not choose a file.
- 3a1. MedBook displays an error message.
- Use case ends.

---

Expand All @@ -1002,14 +1002,14 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
- **Preconditions**: There is at least one record entry with a file attached in the patient
- **Main Success Scenario (MSS)**:

1. User requests to view a file attached to a record.
2. MedBook opens the file on the user’s default launcher.<br>
Use case ends.
1. User requests to view a file attached to a record.
2. MedBook opens the file on the user’s default launcher.<br>
Use case ends.

- **Extension**:
- 1a. File does not exist in user’s local storage.
- 1a1. MedBook displays an error message.
- Use case ends.
- 1a. File does not exist in user’s local storage.
- 1a1. MedBook displays an error message.
- Use case ends.

---

Expand Down
10 changes: 4 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ With MedBook, experience a new level of convenience and control:
- [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)
- [Searching patients by keywords](#searching-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)
Expand All @@ -55,7 +55,7 @@ With MedBook, experience a new level of convenience and control:
- [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)
- [Searching medical records by keywords](#searching-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)
Expand Down Expand Up @@ -169,8 +169,6 @@ Here are some definitions of the terms used throughout this user guide.
**Main Window**:
![Ui Component](images/UiComponent.png)

Here is a brief summary of the GUI components in MedBook.

| **Name of Component** | **Description** |
| --------------------- | -------------------------------------------------------------------------------------------------------- |
| Menu Bar | Displays the drop down menus for MedBook, such as **File** and **Help** |
Expand Down Expand Up @@ -455,7 +453,7 @@ Output

<div style="page-break-after: always;"></div>

#### Locating patients by keywords: `search`
#### Searching patients by keywords: `search`

Searches for patients with details containing the corresponding `KEYWORD`.

Expand Down Expand Up @@ -696,7 +694,7 @@ Example:

---

#### Locating medical records by keywords: `searchrecord`
#### Searching medical records by keywords: `searchrecord`

Searches for medical records of the Patient Being Viewed with details containing the corresponding `KEYWORD`.

Expand Down

0 comments on commit bc50f36

Please sign in to comment.