diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 343f3719679..c827cd523f2 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -169,9 +169,11 @@ Given below is an example usage scenario and how the add mechanism behaves at ea Step 1. The user enters the `add` command with relevant details for the new fosterer. The `AddCommandParser` is invoked to parse the user's input. -Step 2. The `AddCommandParser` processes the user's input and verifies the presence of mandatory fields inputted in the correct format. If this check fails, the system will generate a specific error message indicating which field format is invalid. For example, if the email format is incorrect, the system will report that the email input is invalid. The error message will be displayed to the user, providing clear feedback about the issue and the specific constraints that are not met. +Step 2. The `AddCommandParser` processes the user's input and verifies the presence of mandatory fields inputted in the correct format.
+If this check fails, the system will generate a specific error message indicating which field format is invalid.
+For example, if the email format is incorrect, the system will report that the email input is invalid. The error message will be displayed to the user, providing clear feedback about the issue and the specific constraints that are not met. -Step 3. If all mandatory fields are present with the valid format, the new person is created using the `Person` class. The person's details, including their name, phone, email, address, housing, availability, animal name, animal type, and tags, are recorded, and the Person class also ensures that there is no conflicting data. +Step 3. If all mandatory fields are present with the valid format, the new person is created using the `Person` class. The person's details, including their name, phone, email, address, housing, availability, animal name, animal type, and tags, are recorded, and the Person class also ensures that there is no conflicting data.
If this check fails, the system will generate a specific error message indicating which field is invalid, and how can it be resolved. Step 4. The `Person` is then passed to the new `AddCommand` created, which adds the person to the address book, ensuring that it is not a duplicate of an existing entry. This check is performed in the `execute` method of the `AddCommand`. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c209916705f..cc452385ce4 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -56,7 +56,7 @@ These are symbols we will be using to highlight certain information to you. -------------------------------------------------------------------------------------------------------------------- ## User Interface (UI) -There are mainly two different screens that you may face when using Foster Family. +These are the two different screens you will be interacting with in Foster Family. ### The Main Window ![Ui](images/Ui.png) @@ -133,8 +133,8 @@ If you press Esc key, the exit is cancelled and you can continue working on the The example above is the result of pressing the Esc key after you are warned. -To learn more about **adding a new fosterer through the profile page**, refer to a section [Adding a fosterer through the profile page: add](#adding-a-fosterer-through-the-profile-page-add).
-To learn more about **editing a fosterer through the profile page**, refer to a section about [Editing a fosterer's detail through the profile page: edit](#editing-a-fosterers-detail-through-the-profile-page-edit). +To learn more about **adding a new fosterer through the profile page**, refer to the section [Adding a fosterer through the profile page: add](#adding-a-fosterer-through-the-profile-page-add).
+To learn more about **editing a fosterer through the profile page**, refer to the section [Editing a fosterer's detail through the profile page: edit](#editing-a-fosterers-detail-through-the-profile-page-edit). ## Features @@ -240,8 +240,7 @@ Format: `add` **:information_source: Notes about the command:**
-* Valid cases of a fosterer entry in the section [Adding a fosterer through the main window: add](#adding-a-fosterer-through-the-main-window-add) are still applied in this alternative way to add a fosterer. - +* The restrictions imposed on what makes a valid fosterer, as explained in the section [Adding a fosterer through the main window: add](#adding-a-fosterer-through-the-main-window-add), still applies in this alternative way of adding a fosterer. ![Profile](images/screenshots/ProfilePage.png) @@ -539,14 +538,14 @@ Undoes the previous command, given that the previous command successfully execut Format: `undo` +![Undo](images/screenshots/Undo.png) +
**:information_source: Notes about the command:**
* The `undo` command can only be executed **once** at a time, and it will undo the last successful command. When the `undo` command is executed consecutively more than once, an error message will be shown: ![Undo](images/screenshots/UndoError.png) - * Provided that the previous command was a successful `add`, `delete`, or `edit`, the `undo` command will be executed successfully. -![Undo](images/screenshots/Undo.png)
@@ -554,7 +553,7 @@ Format: `undo` Clears all entries from the address book. -Format: `reset` and `reset confirm` +Format: `reset`, followed by `reset confirm`
@@ -574,9 +573,9 @@ Exits the program. Format: `exit` -
+
-**:bulb: Tip:**
+**:information_source: Notes about the command:**
* On the profile page, entering exit leads you out of the page back to the main window. * On the profile page, attempting to exit without saving changes with save prompts a warning message (refer to [User Interface: The Profile Page: Exiting the profile page](#exiting-the-profile-page)).