Merge pull request AY2324S1-CS2103T-T12-4#23 from adammangzijun/Updat…

…e-Docs Update docs
Darren159 · Oct 4, 2023 · 2c451d3 · 2c451d3
2 parents b9a055f + 3da97dc
commit 2c451d3
Show file tree

Hide file tree

Showing 6 changed files with 107 additions and 34 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -28,14 +28,22 @@ You can reach us at the email `low.darren[at]u.nus.edu`
 [[portfolio](team/hjoneweek.md)]
 * Role: Developer
 
+### Adam Ang Zi Jun
+
+<img src="images/adammangzijun.png" width = "200px">
+
+[[github](https://github.com/adammangzijun)]
+[[portfolio](team/adammangzijun.md)]
+* Role: Developer
+
 ### Lin Yuxiang
 
 <img src="images/clin-lyx.png" width="200px">
 
 [[github](http://github.com/Clin-lyx)]
 [[portfolio](team/clin-lyx.md)]
 
-* Role: Developer 
+* Role: Developer
 * Responsibilities: UI
 
 ### Johnny Doe

diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -276,7 +276,7 @@ _{Explain here how the data archiving feature will be implemented}_
 * prefers typing to mouse interactions
 * is reasonably comfortable using CLI apps
 
-**Value proposition**: 
+**Value proposition**:
 
 * streamline patient management
 * easy access to patients' details such as medical records and contact information
@@ -287,14 +287,35 @@ _{Explain here how the data archiving feature will be implemented}_
 
 Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
 
-| Priority | As a …                                    | I want to …                 | So that I can…                                                        |
-|----------|--------------------------------------------|------------------------------|------------------------------------------------------------------------|
-| `* * *`  | new user                                   | see usage instructions       | refer to instructions when I forget how to use the App                 |
-| `* * *`  | user                                       | add a new person             |                                                                        |
-| `* * *`  | user                                       | delete a person              | remove entries that I no longer need                                   |
-| `* * *`  | user                                       | find a person by name        | locate details of persons without having to go through the entire list |
-| `* *`    | user                                       | hide private contact details | minimize chance of someone else seeing them by accident                |
-| `*`      | user with many persons in the address book | sort persons by name         | locate a person easily                                                 |
+| Priority | As a …                                | I want to …                                                                                               | So that I can…                                                   |
+|----------|----------------------------------------|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------|
+| `* * *`  | user                                   | *add* a patient’s medical records and contact details                                                      | keep track of them efficiently                                    |
+| `* * *`  | user                                   | *view* a list of all the patients in the app                                                               | quickly see all my patients at once                               |
+| `* * *`  | user                                   | *delete* a specific patient’s details from the ap                                                          | remove patients that are no longer relevant or needed             |
+| `* * *`  | user                                   | *edit* an existing patient’s details in the app                                                            | keep the information accurate and up-to-date                      |
+| `* * *`  | user                                   | *search* for specific patients using keywords such as patient’s name or medical record                     | easily search for and locate specific patients in the app         |
+| `* * *`  | user                                   | see the app populated with sample data                                                                     | easily see how the app will look when it is in use                |
+| `* * *`  | new user                                   | access a “help” page to view the app’s functionalities                                                     | learn how to use the application effectively                      |
+| `* * *`  | new user                                   | *clear all* current data                                                                                   | get rid of sample/experimental data I used for exploring the app  |
+| `* * *`  | user                                   | exit the application and save the address book automatically                                               |                                                                   |
+| `* *`    | busy user | *pin* a specific patient                                                                                   | remember to contact them                                          |
+| `* *`    | user                                   | import my patient details into the app                                                                     | efficiently manage my existing patient information                |
+| `* * `   | user                                   | reorganize the address book in terms of appointment date/time and/or alphabetical order of patients’ names | have a sorted list to for other purposes                          |
+| `* *`    | user                                   | receive regular updates and bug fixes for the app                                                          | ensure that it remains functional and bug-free                    |
+| `* *`    | user | attach files such as lab reports and prescription images to a patient's profile                            | maintain a comprehensive record of all patient information        |
+| `* *`    | user                                   | view a history log of all the changes made to a patient's record                                           | track updates and maintain a reliable record                      |
+| `* *`    | expert user                                   | separate my patients into different categories                                                             | easily filter out my patients accordingly                         |
+| `* *`    | busy user | clear the contacts related to a specific patient                                                           | remove them all at one go                                         |
+| `*`      | user | view a daily schedule of patient appointments within the app                                               | prepare for my daily patient consultations                        |
+| `*`      | user                                   | reschedule or cancel appointments within the app                                                           | have flexibility in appointment dates                             |
+| `*`      | user                                   | set access permissions(password protected)                                                                 | allow only authorized personnel to view or modify patient details |
+| `*`      | user                                   | print a patient’s medical record directly from the app                                                     | facilitate physical record keeping and sharing of information     |
+| `*`      | expert user                                   | create reminders for my patients to follow up                                                              | make sure that patients remember their follow up appointment      |
+| `*`      | expert user                                   | record patients who didn’t show up                                                                         | to keep track of patients who tend to miss appointment dates      |
+| `*`      | expert user                                   | export patient data to a CSV file or other common formats                                                  | easily share or transfer data between different systems           |
+| `*`      | busy user | reminders for upcoming patient appointments                                                                | remember to attend all the consultations                          |
+| `*`      | busy user | blacklist certain patients                                                                                 | remove absurd patients                                            |
+
 
 *{More to be added}*
 
@@ -311,6 +332,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 **MSS**
 
 **Use case: UC03 - Listing all patient**
+**Actors**: User (typically a healthcare professional)
+*Preconditions*:
+1. Patient list is displayed and has at least one patient entry.
 
 **MSS**
 
@@ -327,6 +351,21 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 **Use case: UC04 - Editing a patient**
 
+1. User <u>lists all patients (UC03)</u>
+2. User provides the required input: `patient ID`, `detail field`, and `updated patient details`.
+3. MedBook updates the patient entry with new detail.
+4. MedBook shows successful edit details.
+
+   Use case ends.
+
+**Extensions**
+
+* 2a. User gives an invalid input in any of the given field.
+
+    * 2a1. MedBook shows an error message.
+
+      Use case ends.
+
 **MSS**
 
 **Use case: UC05 - Locating a specific patient**

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -119,22 +119,29 @@ Format: `view`
 
 Shows the detailed information of the patient by clicking.
 
-### Editing a person : `edit`
 
-Edits an existing person in the address book.
+### Editing detail of a patient : `editdetail`
 
-Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…`
+Edits an existing person in MedBook.
+
+Format: `editdetail [patient ID/detail field/updated patient details]`
+* Edits the person at the specified `patient ID`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
+* The `detail field` must be provided.
+* Accepted `detail field` : **name**, **email**, **phone**, **gender**, **age**, **blood**, **allergy**.
+* Existing values in the `detail field` will be updated to the `updated patient details` input.
+* **Name**: Text (up to 256 characters)
+* **Email**: Valid email format
+* **Phone**: Number (up to 15 digits)
+* **Gender**: M/F
+* **Age**: Number (0-120)
+* **Blood Type**: One of [A+, A-, B+, B-, AB+, AB-, O+, O-]
+* **Allergies**: Text (up to 512 characters)
 
-* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …
-* At least one of the optional fields must be provided.
-* Existing values will be updated to the input values.
-* When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.
-* You can remove all the person’s tags by typing `t/` without
-    specifying any tags after it.
 
 Examples:
-*  `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
-*  `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+*  `editdetail 1/email/[email protected]` Edits the email address of the 1st person to be `[email protected]`.
+*  `editdetail 2/phone/92345678` Edits the name of the 2nd person to be `92345678`.
+*  `editdetail 3/allergy/aspirin` Edits the allergy of the 3rd person to be `aspirin`.
 
 ### Locating persons by name: `find`
 
@@ -228,13 +235,13 @@ _Details coming soon ..._
 
 ## Command summary
 
-Action     | Format, Examples
------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------
-**Add**    | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
-**Clear**  | `clear`
-**Delete** | `delete [patientId]`<br> e.g., `delete 3`
-**Edit**   | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
-**Find**   | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
-**Pin**    | `pin [patientId]`<br> e.g., `pin 2`
-**List**   | `list`
-**Help**   | `help`
+| Action     | Format, Examples|
+|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Add**    | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`|
+| **List**   | `list`|
+| **Edit**   | `editdetail [patient ID/detail field/updated patient details]`<br> e.g.,`editdetail 1/email/[email protected]`|
+| **Find**   | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`|
+| **Delete** | `delete [patientId]`<br> e.g., `delete 3`|
+| **Pin**    | `pin [patientId]`<br> e.g., `pin 2`|
+| **Clear**  | `clear`|
+| **exit**   | `exit`|
diff --git a/docs/images/adammangzijun.png b/docs/images/adammangzijun.png
diff --git a/docs/team/adammangzijun.md b/docs/team/adammangzijun.md
@@ -0,0 +1,20 @@
+---
+layout: default.md
+title: "Adam's Project Portfolio Page"
+---
+
+### Project: MedBook
+
+Overview: To be added soon
+
+Contributions: To be added soon
+
+* **New Feature 1**
+
+* **New Feature 2**
+
+* **Project management**
+
+* **Documentation**
+
+* **Community**
diff --git a/docs/team/darren159.md b/docs/team/darren159.md
@@ -9,17 +9,16 @@ AddressBook - Level 3 is a desktop address book application used for teaching So
 
 Given below are my contributions to the project.
 
-* **New Feature**: 
+* **New Feature**:
 
 * **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=darren159&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)
 
 * **Project management**:
 
 * **Enhancements to existing features**:
-    
+
 * **Documentation**:
 
 * **Community**:
 
 * **Tools**:
-