diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index ac973c6d482..f704f5b8ff2 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -241,7 +241,7 @@ This sequence diagram shows the interactions between the various components duri ##### Feature Details -1. The user specifies a dentist id that represents a `Dentist` to be edited. +1. The user specifies a `DENTIST_ID` that represents a `Dentist` to be edited. 2. If an invalid `DENTIST_ID` is provided, an error is thrown and the user is prompted to enter the command correctly via an error message. 3. The Dentist is cross-referenced in the `Model` to check if it exists. If it does not, then an error is raised to inform the user. 4. If step 3 completes without any exceptions, then the `Dentist` is successfully deleted. @@ -249,7 +249,7 @@ This sequence diagram shows the interactions between the various components duri ##### Feature Considerations In implementing the delete feature, we needed proper error handling and validation to ensure ToothTracker's robustness and provide clear guidance to the user. -Our approach validates dentist ID and shows an error message if the dentist does not exist. +Our approach validates the `DENTIST_ID` and shows an error message if the dentist does not exist. This is in comparison to allowing commands to fail silently if the dentist specified does not exist. - Pros: Prevents invalid operations and provides immediate feedback to the user, helping to correct mistakes. @@ -318,33 +318,33 @@ keyword is of a valid type for that particular attribute. Users are responsible ### Patient Features - #### Adding a Patient -The `add-patient` command creates a new patient record in ToothTracker. +The `add-patient` command creates a new patient record in ToothTracker. This command forms the fundamental business logic to represent patients. The activity diagram for creating a new patient is illustrated as follows: ![AddPatientActivityDiagram](images/AddPatientActivityDiagram.png) -The sequence diagram of the `add-patient` command: +This sequence diagram shows the interactions between the various components during the execution of the `add-patient` command: ![AddPatientSequenceDiagram](images/AddPatientSequenceDiagram.png) ##### Feature Details -1. Users provide essential patient information, such as their name, phone number, gender, birthday and optional details such as remark, treatment, email, address and tags. +1. Users provide essential patient information, such as their name, phone number, birth date, gender and other optional details like remark, treatment, email and address. 2. In case of missing or invalid command arguments, the system prompts users with an error message to enter the command correctly. -3. The system cross-references the new patients name with existing records in the `Model` to prevent duplicate entries. If a duplicate is found, an error message informs the user. +3. The system cross-references the new patient's name with existing records in the `Model` to prevent duplicate entries. If a duplicate is found, an error message informs the user. 4. If step 3 is completed without any exceptions, the new patient record is created and stored in the system. ##### Feature Considerations -For the optional `Treatment` field, should the user opt to enter a treatment, it is mandatory that the specified treatment already exists within ToothTracker. -If this condition is not met, the user will receive an error message. + +For the optional Treatment field, should the user opt to enter a treatment, it is mandatory that the specified treatment already exists within ToothTracker. +If this condition is not met (the treatment specified does not exist in ToothTracker), the user will receive an error message. #### Deleting a Patient -The `delete-patient` command deletes a patient record in ToothTracker. +The `delete-patient` command deletes a patient record in ToothTracker. This command forms the fundamental business logic to represent patients. The activity diagram for deleting a patient is illustrated as follows: @@ -356,7 +356,7 @@ This sequence diagram shows the interactions between the various components duri ##### Feature Details -1. The user specifies a patient id that represents a `Patient` to be deleted. +1. The user specifies a `PATIENT_ID` that represents a `Patient` to be edited. 2. If an invalid `PATIENT_ID` is provided, an error is thrown and the user is prompted to enter the command correctly via an error message. 3. The Patient is cross-referenced in the `Model` to check if it exists. If it does not, then an error is raised to inform the user. 4. If step 3 completes without any exceptions, then the `Patient` is successfully deleted. @@ -364,8 +364,8 @@ This sequence diagram shows the interactions between the various components duri ##### Feature Considerations In implementing the delete feature, we needed proper error handling and validation to ensure ToothTracker's robustness and provide clear guidance to the user. -Our approach validates patient ID and shows an error message if the patient does not exist. -This is in comparison to allowing commands to fail silently if patient does not exist. +Our approach validates the `PATIENT_ID` and shows an error message if the patient does not exist. +This is in comparison to allowing commands to fail silently if the patient specified does not exist. - Pros: Prevents invalid operations and provides immediate feedback to the user, helping to correct mistakes. - Cons: Additional validation checks add complexity to the code. @@ -404,7 +404,7 @@ The `filter-patient` command in ToothTracker provides users with a more refined specific criteria beyond just `PATIENT_ID` or name-related keywords. This feature offers a versatile and detailed search capability for users who require precise results from the patient records database. -The activity diagram for filtering patient is illustrated as follows: +The activity diagram for filtering patients is illustrated as follows: ![FilterPatientActivityDiagram](images/FilterPatientActivityDiagram.png) @@ -413,7 +413,7 @@ This sequence diagram shows the interactions between the various components duri ![FilterPatientSequenceDiagram](images/FilterPatientSequenceDiagram.png) ##### Feature Details -1. Users initiate a filter for a patient by providing various filter criteria such as Remarks, Treatment and more. +1. Users initiate a filter for a patient by providing various filter criteria such as PHONE, ADDRESS, GENDER, TREATMENT and more. These criteria allow users to search for patients with specific attributes. 2. ToothTracker processes the user's filter criteria and matches them against the patient records in the database. 3. Patients that meet the filter criteria are displayed as search results, providing users with a list of patients that fulfill their specific requirements. @@ -446,7 +446,7 @@ The sequence diagram shows the interactions between the various components durin ##### Feature Details -1. Users provide essential appointment information, such as the dentist ID, patient ID, appointment start time and treatment name. +1. Users provide essential appointment information, such as the `DENTIST_ID`, `PATIENT_ID`, appointment start time and treatment name. 2. In case of missing or invalid command arguments, the system prompts users with an error message to enter the command correctly. 3. The system retrieves information about the treatment cost, duration, dentist and patient from the `Model` using the information provided by the user. 4. The system checks the new appointment's time slot with existing appointments in the `Model` to prevent clashing appointments. @@ -455,7 +455,7 @@ If a timing clash is found, an error message informs the user. ##### Feature Considerations -For the dentist ID, patient ID and treatment field, it is mandatory that the specified dentist, patient and treatment exists in ToothTracker. +For the `DENTIST_ID`, `PATIENT_ID` and treatment field, it is mandatory that the specified dentist, patient and treatment exists in ToothTracker. If these conditions are not met, the user will receive an error message. #### Deleting an Appointment @@ -472,24 +472,23 @@ The sequence diagram shows the interactions between the various components durin ##### Feature Details -1. The user specifies an appointment id that represents an `Appointment` to be deleted. +1. The user specifies an `APPOINTMENT_ID` that represents an `Appointment` to be deleted. 2. If an invalid `APPOINTMENT_ID` is provided, an error is thrown and the user is prompted to enter the command correctly via an error message. 3. The Appointment is cross-referenced in the `Model` to check if it exists. If it does not, then an error is raised to inform the user. 4. If step 3 completes without any exceptions, then the `Appointment` is successfully deleted. ##### Feature Considerations -In implementing the delete feature, we needed proper error handling and validation to ensure ToothTracker's robustness and provide clear guidance to the user. -Our approach validates appointment ID and shows an error message if the appointment does not exist. -This is in comparison to allowing commands to fail silently if appointment does not exist. +In implementing the `delete-appointment` feature, we needed proper error handling and validation to ensure ToothTracker's robustness and provide clear guidance to the user. +Our approach validates `APPOINTMENT_ID` and shows an error message if the appointment does not exist. +This is in comparison to allowing commands to fail silently if an appointment does not exist. - Pros: Prevents invalid operations and provides immediate feedback to the user, helping to correct mistakes. - Cons: Additional validation checks add complexity to the code. - #### Filtering an Appointment -The `filter-appointment` command filters appointments by DENTIST_ID or PATIENT_ID. +The `filter-appointment` command filters appointments by `DENTIST_ID` or `PATIENT_ID`. The activity diagram for filtering an appointment is illustrated as follows: @@ -509,12 +508,12 @@ The sequence diagram shows the interactions between the various components durin ##### Feature Considerations -Validity checks are performed to ensure that the `DENTIST_ID` or `PATIENT_ID` are valid and that they type of ID to filter by is clearly stated. -Otherwise, user would receive an error message that guides them to input the right command and details. +Validation checks are performed to ensure that the `DENTIST_ID` or `PATIENT_ID` is valid and is clearly stated. +Otherwise, the user would receive an error message that prompts them to input the correct command and details. -If no appointments with the specific dentist or patient are found in ToothTracker, it should be clearly -communicated to the user instead of just displaying an empty list. A message stating that no appointments with the -specified `DENTIST_ID` or `PATIENT_ID` are found would be displayed to the user. +If no appointments with the specified dentist or patient are found in ToothTracker, it should be clearly +communicated to the user instead of just displaying an empty list. A message stating that no appointments are found with the +specified `DENTIST_ID` or `PATIENT_ID` should be displayed to the user. ### Treatment Features @@ -532,7 +531,7 @@ The sequence diagram of the `add-treatment` command: ##### Feature Details 1. Users would key in the available treatments in their clinic, specifying the treatment name, cost and its duration. -2. In case of missing or invalid command arguments, the system prompts users with an error message to enter the command correctly. +2. In the event of missing or invalid command arguments, the system prompts users with an error message to enter the command correctly. 3. The system cross-references the new treatment name with existing records in the `Model` to prevent duplicate entries. If a duplicate is found, an error message informs the user. 4. If step 3 is completed without any exceptions, the new treatment record is created and stored in the system. @@ -542,17 +541,17 @@ The sequence diagram of the `add-treatment` command: The `list-treatment` command would list all treatments recorded in ToothTracker. ##### Feature Details -1. Users would key in the `list-treatment` +1. Users would key in `list-treatment`. 2. All available treatments would be listed in the command box. 3. In the event that there are no treatments, ToothTracker would display a message in the command box. ##### Feature Considerations -- Due to the space constraints of ToothTracker, only treatment names would be displayed to the user. -Ideally, cost and duration of each treatment should be shown to the user. However, this would clutter -up the command box pretty quickly. -- Ideally, another window would be created, which would display all available treatments and their -associated costs and durations. +To optimize the user interface within the limited space constraints of ToothTracker, we have chosen to only display the treatment names to the user. +While it would be ideal to present the cost and duration of each treatment directly, this can easily lead to clutter within ToothTracker. +To address this problem, we will consider implementing a separate window in future implementations that provides a comprehensive overview of all available treatments, +along with their respective costs and durations. This additional window will ensure that users can still access detailed information without overwhelming the main interface. +By doing so, we maintain a clean and user-friendly design while offering detailed information regarding treatment types. #### Deleting a Treatment @@ -568,8 +567,133 @@ This sequence diagram shows the interactions between the various components duri ### General Features +##### Exit ToothTracker +The `exit` command is used to close or exit the ToothTracker application. This command provides a way to leave the application. + +##### Clear +The `clear` command is used to refresh the display within ToothTracker. It removes any unnecessary information from the command box, providing a clean slate for a better user experience. + +##### Help +The `help` command is used to access a guide or information on available commands and their usage within ToothTracker. This command serves as a quick reference to assist users in navigating the application. + -------------------------------------------------------------------------------------------------------------------- +## **Future Implementation** + +### Filter Feature Enhancement +#### Overview +As a future improvement to the filter feature, we are considering implementing validation for keyword arguments to ensure that they are valid +for the specified attribute. This enhancement aims to provide a more robust and user-friendly filtering mechanism, preventing the use of irrelevant or incorrect keywords. + +#### **Validation of Keywords** + +Currently, the filter feature checks the validity of the attribute to filter by but does not validate the keywords provided. For instance, if filtering by the attribute "birthday," users can enter nonsensical or invalid keywords, +potentially leading to undesired results. + +To address this, the following steps can be taken: + +1. **Define Valid Keywords:** + - Establish a set of valid keywords for each attribute that can be used in the filter command. + +2. **Keyword Validation Check:** + - Modify the filter feature to validate the provided keywords against the predefined set of valid keywords for the specified attribute. + +3. **Informative Error Messages:** + - Provide informative error messages if users attempt to filter using invalid keywords, guiding them on the correct usage. + +4. **User Guide Update:** + - Update the User Guide to include information about valid keywords for each attribute, ensuring users are aware of the allowed values. + +This enhancement contributes to the overall reliability and user experience of the filter feature, making it more robust and user-friendly. + +### Command History + +#### Overview +Introduce a command history feature to enhance the user experience by allowing users to retrieve and reuse their last entered commands. +This functionality is similar to the up arrow functionality in most IDEs or terminals, providing users with a convenient way to recall and execute previous commands. + +#### Key Features + +1. **Command History Navigation:** + - Allow users to navigate through their command history using arrow keys (up and down) within the CLI interface. + +2. **Display Previous Commands:** + - Implement a mechanism to display a list of previous commands as the user navigates through the history. This can be shown either in-place or in a separate section of the CLI. + +3. **Immediate Execution:** + - Enable users to immediately execute a command from the history by selecting it. This streamlined process saves time and enhances user efficiency. + +4. **Persistent History Across Sessions:** + - Ensure that the command history is persistent across different sessions of the application, allowing users to access their command history even after closing and reopening the CLI. +5. **Configurable History Size:** + - Provide users with the ability to configure the size of their command history. This allows customization based on individual preferences and workflow. + +#### Usage Example +```plaintext +$ user@cli-app:~$ [User enters a command] +$ user@cli-app:~$ [User presses the up arrow] +$ user@cli-app:~$ [Previous command from history is displayed] +$ user@cli-app:~$ [User presses Enter to execute the displayed command] +``` + +#### Benefits + +1. **Improved Efficiency:** +Users can quickly access and reuse previously entered commands, reducing the need to type repetitive commands manually. + + +2. **User-Friendly Interaction:** +Enhances the overall user experience by providing a familiar and intuitive command history navigation, similar to other CLI interfaces. + + +### List-Treatment Feature Enhancement +#### Overview +The current 'list-treatment' command outputs all available treatment names in a text box due to time and UI constraints. Including additional details such as duration and cost would overcrowd the command box. +To address these limitations, a future enhancement for the 'list-treatment' command could be the introduction of a new popup window. This window would present a table with columns for treatment name, cost, and duration when the command is entered. + +#### Benefits + +1. **Improved Readability** + - A table format allows users to quickly scan and compare options, making it easier to digest information at a glance. Clear separation of data into columns would significantly enhance the readability of the information. + +2. **Enhanced User Experience** + - A popup window would declutter the main command box, leading to a cleaner and more focused user interface. This would allow users to stay in the context of the command while accessing detailed information without being overwhelmed. + + +### Quick Notes Feature Enhancement +#### Overview +The current quick notes box features white as the text selection color, which causes selected text to blend into the white background, +rendering it invisible. A proposed enhancement is to change the selection color to grey to maintain the visibility of the selected text. + +#### Benefits +1. **Enhanced Visibility** + - Grey text selection would stand out against a white background, making it easier for users to see what text they have selected. This would prevent the problem of text 'disappearing' upon selection. +2. **User Accessibility** + - The change would be a significant improvement for users with visual impairments or those working in brightly lit environments where screen glare can make it hard to distinguish between colors with low contrast. + + +### Appointment Name Updater +#### Overview +The current implementation of the appointments class stores all data as strings, leading to inconsistencies when a patient or dentist's name is changed, as this change is not automatically reflected in existing appointments. To address this, we could implement an update script for the 'edit-patient' and 'edit-dentist' commands that would: + +1. Search through the list of appointments. +2. Identify appointments that contain the ID of the patient or dentist whose name has been edited. +3. Update the relevant name field to reflect the new name. + +This enhancement would ensure that name changes are consistently carried out across all records, thereby maintaining data integrity and coherence. + +### Future Appointment Updater +#### Overview +In the current implementation of ToothTracker, the deletion of a patient or dentist does not automatically remove their association with future appointments, which leads to obsolete records. To rectify this, we could integrate a script into the 'delete patient/dentist' command with the following steps: + +1. Conduct a search through the appointments list. +2. Locate any future appointments linked to the ID of the patient or dentist who has been deleted. +3. Proceed to remove these identified future appointments from the system. + +This would ensure the automatic removal of any future appointments related to patients or dentists who have been deleted, thereby maintaining an accurate and up-to-date schedule within ToothTracker. + + +-------------------------------------------------------------------------------------------------------------------- ## **Documentation, logging, testing, configuration, dev-ops** * [Documentation guide](Documentation.md) @@ -611,11 +735,10 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* * *` | receptionist | search for dentists by name or ID | i have quick access to dentist profiles | | `* *` | receptionist | view costs of various dental treatments | tell customers the price of a dental treatment | -*{More to be added}* ### Use cases -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified +(For all use cases below, the **System** is `ToothTracker` and the **Actor** is the `user`, unless specified otherwise) --- @@ -1144,7 +1267,6 @@ Use case ends. Use case continues from step 2. -*{More to be added}* ### Non-Functional Requirements diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 10bef2a15fe..fb09ed38a87 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -10,12 +10,16 @@ ToothTracker is a **Dental Clinic Administrative Management System** designed fo From adding new patient and dentist profiles to seamlessly creating appointment schedules, ToothTracker is engineered to simplify every aspect of your dental clinic administrative responsibilities. +
+ **Why ToothTracker? Because Your Time Matters.**
In your bustling dental clinic, time is the rarest commodity. That's why we designed ToothTracker to be swift like your service, -allowing you to manage patient and dentist records efficiently, schedule appointments without overlaps, +allowing you to **manage patient and dentist records efficiently**, **schedule appointments without overlaps**, and ensure your clinic operates like a well-oiled machine — all through a versatile Command Line Interface (CLI) that responds to your speedy typing, along with a Graphical User Interface (GUI) that includes a user-friendly calendar. +
+ **ToothTracker's Core Features Designed with You in Mind** - **Digital Record Keeping:** Say goodbye to cumbersome physical files — store and manage patients, dentists and appointments digitally. @@ -739,7 +743,7 @@ data file at the next run. Hence, it is recommended to take a backup of the file {% include page-break.html %} ## Troubleshooting - + {: .no_toc} #### Checking your system's Java version Check that your system has the correct Java version (**Java 11 and above**) installed to run ToothTracker. Follow the steps below: @@ -754,7 +758,7 @@ Check that your system has the correct Java version (**Java 11 and above**) inst 2. Type in `Terminal` and open the terminal. 3. Key in `java --version` and press `Return` to check your Java version. -- FOr Linux Users: +- For Linux Users: 1. Press `Ctrl + Alt + T` to open the Terminal. 2. Key in `java --version` and press `Enter` to check your Java version. diff --git a/docs/_includes/quickstart.md b/docs/_includes/quickstart.md index f63bb4e9400..a227c5a2674 100644 --- a/docs/_includes/quickstart.md +++ b/docs/_includes/quickstart.md @@ -47,22 +47,24 @@ Let's learn what each of these components does! ![ToothTracker UI](images/UiAnnotated.png){: .centered-image-full-size } -| | Component | Description | -|---|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 1 | Menu Bar | The menu bar contains menu options to [exit](#exiting-the-program-exit) from ToothTracker and access [help](#viewing-help--help) resources. | -| 2 | Command Input | The command input is where you can key in your commands to tell ToothTracker what you want to get done. To learn more about ToothTracker's CLI, refer to the [next section](#toothtrackers-command-line-interface-cli). | -| 3 | Result Display | The result display area shows you the outcomes or feedback from your entered commands. | -| 4 | Patient List | This panel lists all patients currently registered in your clinic. It includes vital information such as names, contact details, and other fields. | -| 5 | Dentist List | Here, you'll find a roster of dentists associated with your clinic, complete with their specializations and contact information. | -| 6 | Appointment List | Check the appointment list for the schedule, status, and details of all clinic appointments. | -| 7 | Quick Notes | A dedicated space at the bottom of the Main Window for on-the-fly notes, reminders, or observations that you need to keep handy. | -| 8 | Saved Data File | For advanced users, the [file path](#glossary) displayed here is where ToothTracker stores your saved data (which you can [edit](#editing-the-data-file)). | - -##### Quick Notes +| | Component | Description | +|---|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Menu Bar | The menu bar contains menu options to [exit](#exiting-the-program-exit) from ToothTracker and access [help](#viewing-help--help) resources. | +| 2 | Command Input | The command input is where you can key in your commands to tell ToothTracker what you want to get done. To learn more about ToothTracker's CLI, refer to the [next section](#using-toothtrackers-cli). | +| 3 | Result Display | The result display area shows you the outcomes or feedback from your entered commands. | +| 4 | Patient List | This panel lists all patients currently registered in your clinic. It includes vital information such as names, contact details, and other fields. | +| 5 | Dentist List | Here, you'll find a roster of dentists associated with your clinic, complete with their specializations and contact information. | +| 6 | Appointment List | Check the appointment list for the schedule, status, and details of all clinic appointments. | +| 7 | [Quick Notes](#quick-notes) | A dedicated space at the bottom of the Main Window for on-the-fly notes, reminders, or observations that you need to keep handy. | +| 8 | Saved Data File | For advanced users, the [file path](#glossary) displayed here is where ToothTracker stores your saved data (which you can [edit](#editing-the-data-file)). | + +{: .no_toc} +#### Quick Notes Quick Notes is designed to enhance your efficiency by providing a space for immediate note-taking within the application. Use the quick notes to help you capture important reminders or information swiftly without navigating away from the main window. -**How to use the Quick Notes:**
+{: .no_toc} +##### How to use the Quick Notes
**1. Adding Notes**: Click into the Quick Notes Box and type your notes. @@ -97,71 +99,78 @@ It allows you to easily understand your clinic's appointments and availability a ### Using ToothTracker's CLI -ToothTracker is optimized for use via a Command Line Interface which means you can do what you want to get done just +ToothTracker is optimized for use via a CLI which means you can do what you want to get done just by using text input (known as commands). Right now, ToothTracker only understands certain commands (the complete list of commands can be found in [Features](#features)) -and these commands must be formatted in a specific way. -It’s just the way ToothTracker is wired to think and listen. So let’s learn how to talk to ToothTracker! +and these commands must be formatted in a specific way. So let’s learn how to communicate your needs to ToothTracker! {: .no_toc} #### How to Input Commands -Think of the Command Input as ToothTracker’s ‘ears’. This is the rectangular text input box outlined in red below. +Think of the [Command Input](#main-window) as ToothTracker’s ‘ears’ — always ready to listen to your instructions. 1. Click on the Command Input box. 2. Type in your command. 3. Press ‘Enter’ on your keyboard (or ‘return’ if you're on a Mac). -That's it! ToothTracker has just executed your command. It’s that easy! +That's it! ToothTracker has just executed your command. Yes, it's as simple as that! {: .no_toc} #### Understanding Command Format Every command you input follows a simple structure to help ToothTracker understand your needs: -* **Command Word:** This is the first word of your command. It acts like a direct order to ToothTracker, telling it precisely what action you want to take. -* **Index:** When your command relates to a specific patient, dentist or appointment, you'll use an index. It's a unique number assigned to each entry in the respective lists. +* **Command Word:** This is the first word of your command. It acts as a unique keyword that tells ToothTracker precisely what command you want to execute. +* **Index:** The index is simply a number to uniquely identify each patient, dentist or appointment. When your command relates to a specific patient, dentist or appointment, you'll need to use an index. * **Flags:** These are markers to distinguish between inputs. A flag is usually followed by a placeholder. -* **Placeholders:** These are temporary labels that you'll replace with actual data. For instance, replace 'TREATMENT' in tr/TREATMENT with the real name of a treatment, like tr/Braces. +* **Placeholders:** These are temporary labels that you'll replace with actual data. For instance, replace 'TREATMENT' in `tr/TREATMENT` with the real name of a treatment, like `tr/Braces`. ### Trying out your first commands -Can't wait to get started with ToothTracker? Let's go through some simple commands together to get you warmed up before you dive into ToothTracker's full feature list! +Can't wait to get started with ToothTracker? +Let's go through some straightforward commands to get a feel for how easy managing your clinic's data can be.
- **:information_source:** Images in this section are only meant to be used as **references**. - Data shown in this sample reference may differ from the data stored in your ToothTracker. + **:information_source:** Remember, the images in this section are just **examples** to guide you. + Your ToothTracker will show information specific to your own clinic.
-Let's start by going through some simple dentist-related commands! +Let's start with adding and managing your clinic's dental team: + +1. **Welcoming a new dentist**: +Suppose Dr. Jonathan Goh is the latest addition to your dental team. Let's get him into the ToothTracker system.
+Type `add-dentist n/Jonathan Goh p/92095568 e/jonathan.goh@gmail.com y/3 s/Paediatric Dentistry` and press Enter. + - Just like that, Dr. Jonathan Goh is part of your digital roster! -1. Suppose you have a dentist, named Jonathan Goh, who joined your clinic.
-Try running the command `add-dentist n/Jonathan Goh p/92095568 e/jonathan.goh@gmail.com y/3 s/Paediatric Dentistry`. - - Notice that you've created a new dentist, Jonathan Goh! + ![trying-command-add-dentist-example](images/ug/add-dentist-example.png){: .centered-image-full-size } -![trying-command-add-dentist-example](images/ug/add-dentist-example.png){: .centered-image-full-size } +2. **Saying farewell**: If Dr. Alex Yeoh is leaving your clinic, you can keep your records up-to-date by removing his details. + Simply run `delete-dentist 1`. + - After executing the command, Dr. Alex Yeoh's information is now deleted from ToothTracker. -2. Now, suppose that a dentist, Alex Yeoh, is leaving your clinic, and you want to delete his records from ToothTracker. -You can do this by running `delete-dentist 1`. - - After executing the command, Alex Yeoh is now deleted from ToothTracker! +
+ + **:bulb:** Always ensure the `DENTIST_ID` matches the identifier on the dentist's card within ToothTracker. + +
-![trying-command-delete-dentist-example](images/ug/delete-dentist-example.png){: .centered-image-full-size } + ![trying-command-delete-dentist-example](images/ug/delete-dentist-example.png){: .centered-image-full-size } -Now that you’ve been introduced to some dentist-related commands, let’s change things up by trying out some patient commands. +Now let's see how easy it is to manage patient information. -1. Suppose you have a new patient, named Jean, onboarding your clinic.
-Try entering the command `add-patient n/Jean p/95339212 b/14-09-2001 g/F`. +1. **Registering a new patient**: Suppose you have a new patient, named Jean, onboarding your clinic.
+Enter `add-patient n/Jean p/95339212 b/14-09-2001 g/F` and press enter. - Notice that you've created a new patient, Jean! -![trying-command-add-patient-example](images/ug/add-patient-example.png){: .centered-image-full-size } + ![trying-command-add-patient-example](images/ug/add-patient-example.png){: .centered-image-full-size } -2. Now, suppose that you want to change the phone number of your patient, Alex. Easy! Just type in `edit-patient 1 p/82019452`. +2. **Updating patient info**: Now, suppose that Alex wants to update his phone number. Easy! Just type in `edit-patient 1 p/82019452`. - Done! Alex's phone number has been updated! -![trying-command-edit-patient-example](images/ug/edit-patient-example.png){: .centered-image-full-size } + ![trying-command-edit-patient-example](images/ug/edit-patient-example.png){: .centered-image-full-size } Awesome! Now that you've gotten familiar with ToothTracker's commands, feel free to explore more features in the [Features](#features) section to fully leverage ToothTracker's capabilities. diff --git a/docs/diagrams/AddPatientActivityDiagram.puml b/docs/diagrams/AddPatientActivityDiagram.puml index 8a0eb2594fe..7572e2682d5 100644 --- a/docs/diagrams/AddPatientActivityDiagram.puml +++ b/docs/diagrams/AddPatientActivityDiagram.puml @@ -1,17 +1,22 @@ @startuml -skinparam ActivityFontSize 15 -skinparam ArrowFontSize 12 start -:User Input; -if (valid input) then (yes) - :Check duplicate patient; - if (no duplicate patient) then (yes) - :Add patient into ToothTracker; - else (no) - :Throw error message; - endif -else (no) - :Throw error message; +:User executes "add-patient" command with required details; + +if () then ([valid command]) + :Create Patient object from command arguments; + +:Check if Patient already exists in model; + +if () then ([Patient already exists]) + :Throw CommandException "Patient already exists"; +else ([else]) + :Add new Patient to model; + :Return message to show new Patient added; endif + +else ([else]) + :Display error message for invalid command; +endif + stop @enduml diff --git a/docs/diagrams/AddPatientSequenceDiagram.puml b/docs/diagrams/AddPatientSequenceDiagram.puml index 1be88c84b09..03cd331c509 100644 --- a/docs/diagrams/AddPatientSequenceDiagram.puml +++ b/docs/diagrams/AddPatientSequenceDiagram.puml @@ -14,10 +14,10 @@ box Model MODEL_COLOR_T1 participant ":Model" as Model MODEL_COLOR end box -[-> LogicManager : execute("add-patient n/John Doe ...") +[-> LogicManager : execute("add-patient n/Jean p/95339212 b/14-09-2001 g/F") activate LogicManager -LogicManager -> AddressBookParser : parseCommand("add-patient n/John Doe ...") +LogicManager -> AddressBookParser : parseCommand("add-patient n/Jean p/95339212 b/14-09-2001 g/F") activate AddressBookParser create AddPatientCommandParser @@ -27,7 +27,7 @@ activate AddPatientCommandParser AddPatientCommandParser --> AddressBookParser deactivate AddPatientCommandParser -AddressBookParser -> AddPatientCommandParser : parse("n/John Doe ...") +AddressBookParser -> AddPatientCommandParser : parse("n/Jean p/95339212 b/14-09-2001 g/F") activate AddPatientCommandParser create AddPatientCommand diff --git a/docs/diagrams/AddTreatmentActivityDiagram.puml b/docs/diagrams/AddTreatmentActivityDiagram.puml index 65bfd083f7d..4b1c59531f8 100644 --- a/docs/diagrams/AddTreatmentActivityDiagram.puml +++ b/docs/diagrams/AddTreatmentActivityDiagram.puml @@ -1,17 +1,16 @@ @startuml -skinparam ActivityFontSize 15 -skinparam ArrowFontSize 12 start -:User Input; -if (valid input) then (yes) - :Check duplicate treatment; - if (no duplicate treatment) then (yes) +:User executes "add-treatment" command; + +if () then ([valid command]) + :Check if it is a duplicate treatment; + if () then ([duplicate treatment]) :Add treatment into ToothTracker; - else (no) + else ([else]) :Throw error message; endif -else (no) - :Throw error message; +else ([else]) + :Display error message for invalid command; endif stop @enduml diff --git a/docs/diagrams/DeletePatientActivityDiagram.puml b/docs/diagrams/DeletePatientActivityDiagram.puml index 8824ad5ca69..563b283f0f4 100644 --- a/docs/diagrams/DeletePatientActivityDiagram.puml +++ b/docs/diagrams/DeletePatientActivityDiagram.puml @@ -6,11 +6,11 @@ if () then ([valid command]) :Parse PATIENT_ID from command arguments; if () then ([Patient record exists]) - :Retrieve patient by ID; - :Delete patient record; + :Retrieve Patient by ID; + :Delete Patient record; :Return success message; else ([else]) - :Throw CommandException for no patient found; + :Throw CommandException for no Patient found; endif else ([else]) diff --git a/docs/diagrams/DeletePatientSequenceDiagram.puml b/docs/diagrams/DeletePatientSequenceDiagram.puml index 273b77a33f9..42ef1d13bf8 100644 --- a/docs/diagrams/DeletePatientSequenceDiagram.puml +++ b/docs/diagrams/DeletePatientSequenceDiagram.puml @@ -49,7 +49,12 @@ deactivate AddressBookParser LogicManager -> DeletePatientCommand : execute() activate DeletePatientCommand -DeletePatientCommand -> Model : deletePatient(1) +DeletePatientCommand -> Model : getPatientById(1) +activate Model +Model --> DeletePatientCommand +deactivate Model + +DeletePatientCommand -> Model : DeletePatient(1) activate Model Model --> DeletePatientCommand diff --git a/docs/images/AddPatientActivityDiagram.png b/docs/images/AddPatientActivityDiagram.png index 0bd33976dba..327ac496322 100644 Binary files a/docs/images/AddPatientActivityDiagram.png and b/docs/images/AddPatientActivityDiagram.png differ diff --git a/docs/images/AddPatientSequenceDiagram.png b/docs/images/AddPatientSequenceDiagram.png index d2ba41fd986..e66d64ee12f 100644 Binary files a/docs/images/AddPatientSequenceDiagram.png and b/docs/images/AddPatientSequenceDiagram.png differ diff --git a/docs/images/AddTreatmentActivityDiagram.png b/docs/images/AddTreatmentActivityDiagram.png index ef2a914bba2..3e9d4e2f4cc 100644 Binary files a/docs/images/AddTreatmentActivityDiagram.png and b/docs/images/AddTreatmentActivityDiagram.png differ diff --git a/docs/images/DeletePatientActivityDiagram.png b/docs/images/DeletePatientActivityDiagram.png index aef88dc941f..3a5ac75c30d 100644 Binary files a/docs/images/DeletePatientActivityDiagram.png and b/docs/images/DeletePatientActivityDiagram.png differ diff --git a/docs/images/DeletePatientSequenceDiagram.png b/docs/images/DeletePatientSequenceDiagram.png index b0438248254..832ea3a0a75 100644 Binary files a/docs/images/DeletePatientSequenceDiagram.png and b/docs/images/DeletePatientSequenceDiagram.png differ diff --git a/docs/index.md b/docs/index.md index 158a8788095..4fcedd04b15 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,10 +11,10 @@ title: ToothTracker ToothTracker is an **All-in-One solution for Effortless Dental Clinic Record Management.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface). -* If you are interested in using ToothTracker, head over to the [**Installation Guide**](UserGuide.html#installation). +* If you are interested in using ToothTracker, head over to the [**Get Started with ToothTracker**](UserGuide.html#get-started-with-toothtracker). * If you are interested about developing ToothTracker, the [**Developer Guide**](DeveloperGuide.html) is a good place to start. **Acknowledgements** -* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5) +* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5), [CalendarFX](https://github.com/dlsc-software-consulting-gmbh/CalendarFX) diff --git a/docs/team/techjay-c.md b/docs/team/techjay-c.md index 4a6c54fbe86..70ff1374f3d 100644 --- a/docs/team/techjay-c.md +++ b/docs/team/techjay-c.md @@ -3,42 +3,94 @@ layout: page title: Jaryl Chew's Project Portfolio Page --- +{: .no_toc} ### Project: ToothTracker -ToothTracker is a simple to use, all-in-one application that allows front desk administration staff to easily manage a -clinic. Manage patients, dentists and increase the efficiency of operations, all in one place. +ToothTracker is an all-in-one application designed for front desk administration staff to efficiently manage clinic operations, +including patient and dentist management. Given below are my contributions to the project. -* **New Feature**: Added the ability to - * What it does: - * Justification: - * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in - the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* +* **New Feature: Search Dentist** + * **What it does:** Adds the ability to search for dentists in ToothTracker based on either their `DENTIST_ID` or keywords in their names. + * **Justification:** This feature enhances the user experience by providing quick access to specific dentists and facilitating efficient information retrieval. + * **Credits:** + - Solution adapted and inspired from https://chat.openai.com/share/c95e431a-4406-4a1e-b88f-cbff729f1cca + - Solution adapted and inspired from https://chat.openai.com/share/d392c3fe-0d09-40ef-8f28-e4e5e6ced48b + - Third-party libraries: N/A -* **New Feature**: -* **Code contributed**: [RepoSense link]() +* **New Feature: Search Patient** + * **What it does:** Adds the ability to search for patients in ToothTracker based on either their `PATIENT_ID` or keywords in their names. + * **Justification:** This feature enhances the user experience by providing quick access to specific patients and facilitating efficient information retrieval. + * **Credits:** + - Third-party libraries: N/A + + +* **New Feature: Delete Patient** + * **What it does:** Introduces the ability to delete a patient from ToothTracker using their `PATIENT_ID`. + * **Justification:** Enables users to manage their patient database effectively by allowing patient records to be removed easily. + * **Credits:** + - No code/ideas reused. + - Third-party libraries: N/A + + +* **New Feature: Filter Dentist** + * **What it does:** Adds the functionality to filter dentists based on specified attributes such as their name, phone, specialization, experience, email, address, and tags. + * **Justification:** Enhances the search capabilities, allowing users to narrow down dentist results based on a set of specified criteria. + * **Credits:** + - No code/ideas reused. + - Third-party libraries: N/A + + +* **New Feature: Filter Patient** + * **What it does:** Adds the functionality to filter patients based on specified attributes such as their name, phone, birthday, gender, remark, treatment, email, address and tags. + * **Justification:** Enhances the search capabilities, allowing users to narrow down patient results based on a set of specified criteria. + * **Credits:** + - No code/ideas reused. + - Third-party libraries: N/A + + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=techjay-c&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code&since=2023-09-22) + * **Project management**: - * Managed releases `v` - `v` ( releases) on GitHub + * Managed releases `v1.1` - `v1.4` ( releases) on GitHub + + +* **Contributions to team-based tasks**: + * Enabled Assertions in team repository, enhancing code quality and reliability + * **Enhancements to existing features**: - * Updated (Pull requests [\#](), [\#]()) - * Wrote [\#](), [\#]()) + * Add Search Dentist Feature [\#59](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/59) + * Add Search Patient Feature [\#60](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/60) + * Update Search Dentist Feature [\#75](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/75) + * Update Search Dentist Feature [\#78](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/78) + * Add Filter Patient Feature [\#104](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/104) + * Add Filter Dentist Feature [\#110](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/110) + * Update Filter Dentist and Filter Patient Feature [\#117](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/117) + * Add Unit Tests for Search Dentist and Search Patient [\#132](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/132) + * Add Unit Tests for Filter Dentist and Filter Patient [\#132](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/132) + * Add Unit Tests for Delete Dentist and Delete Patient [\#136](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/136) + * Update Filter Dentist and Filter Patient Feature [\#139](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/139) + * Add Unit Tests for attributes in Filter Dentist and Filter Patient Feature [\#209](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/209) + * **Documentation**: * User Guide: - * Added documentation for the features `add`, `list`, `delete` and `search` [\#]() - * Did cosmetic tweaks to existing documentation of features ``, ``: [\#]() - * Developer Guide: - * Added implementation details of the `` feature. + * Update Use Cases for Search Dentist, Delete Dentist [\#38](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/38) + * Update User Guide and Command Descriptions [\#114](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/114) + * Added documentation for the features `search-dentist`, `search-patient`, `delete-dentist`, `delete-patient`, `filter-dentist`, `filter-patient` [\#145](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/145) + * Add user guide updates #152 [\#152](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/152) -* **Community**: - * PRs reviewed (with non-trivial review comments): [\#](), [\#](), [\#](), [\#]() - * Contributed to forum discussions (examples: [](), [](), [](), []()) - * Reported bugs and suggestions for other teams in the class (examples: [](), [](), []()) - * Some parts of the history feature I added was adopted by several other class mates ([](), []()) + * Developer Guide: + + * Add Activity and Sequence Diagram for Search Dentist [\#124](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/124) + * Add Activity and Sequence Diagram for Filter Dentist [\#134](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/134) + * Add Activity and Sequence Diagram for Add Dentist, Filter Patient, Filter Dentist [\#214](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/214) + * Update diagrams in DG(Search Dentist, Filter Dentist, Delete Dentist) [\#214](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/214) -* **Tools**: - * Integrated + +* **Community**: + * PRs reviewed (with non-trivial review comments): [\#84](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/84), [\#143](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/143), [\#154](https://github.com/AY2324S1-CS2103T-W10-3/tp/pull/154), [\#]()