From 3757ba1d4a30c11c0797cf4f2477b8dea0bebd9a Mon Sep 17 00:00:00 2001 From: Matthew Sung Date: Tue, 14 Nov 2023 11:51:07 +0800 Subject: [PATCH 1/4] Remove references to AB3 --- docs/DeveloperGuide.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 18b8c31f274..35f8df5a5b5 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -36,7 +36,7 @@ Given below is a quick overview of main components and how they interact with ea **Main components of the architecture** -**`Main`** (consisting of classes [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down. +**`Main`** (consisting of classes [`Main`](https://github.com/AY2324S1-CS2103-T16-1/tp/blob/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/AY2324S1-CS2103-T16-1/tp/blob/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down. * At app launch, it initializes the other components in the correct sequence, and connects them up with each other. * At shut down, it shuts down the other components and invokes cleanup methods where necessary. @@ -68,13 +68,13 @@ The sections below give more details of each component. ### UI component -The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java) +The **API** of this component is specified in [`Ui.java`](https://github.com/AY2324S1-CS2103-T16-1/tp/blob/master/src/main/java/seedu/address/ui/Ui.java) ![Structure of the UI Component](images/UiClassDiagram.png) The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `EmployeeListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class which captures the commonalities between classes that represent parts of the visible GUI. -The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/resources/view/MainWindow.fxml) +The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the [`MainWindow`](https://github.com/AY2324S1-CS2103-T16-1/tp/blob/master/src/main/java/seedu/address/ui/MainWindow.java) is specified in [`MainWindow.fxml`](https://github.com/AY2324S1-CS2103-T16-1/tp/blob/master/src/main/resources/view/MainWindow.fxml) The `UI` component, @@ -85,7 +85,7 @@ The `UI` component, ### Logic component -**API** : [`Logic.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/logic/Logic.java) +**API** : [`Logic.java`](https://github.com/AY2324S1-CS2103-T16-1/tp/tree/master/src/main/java/seedu/address/logic/Logic.java) Here's a (partial) class diagram of the `Logic` component: @@ -114,7 +114,7 @@ How the parsing works: * All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing. ### Model component -**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java) +**API** : [`Model.java`](https://github.com/AY2324S1-CS2103-T16-1/tp/tree/master/src/main/java/seedu/address/model/Model.java) @@ -135,7 +135,7 @@ The `Model` component, ### Storage component -**API** : [`Storage.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/storage/Storage.java) +**API** : [`Storage.java`](https://github.com/AY2324S1-CS2103-T16-1/tp/tree/master/src/main/java/seedu/address/storage/Storage.java) From 5d348fdc58f10726e49fb13e4a93d18c0a73944c Mon Sep 17 00:00:00 2001 From: Matthew Sung Date: Tue, 14 Nov 2023 12:02:07 +0800 Subject: [PATCH 2/4] Update DG and remove to be completed parts --- docs/DeveloperGuide.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 35f8df5a5b5..2f81ccdb893 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -323,11 +323,11 @@ The following activity diagram summarizes what happens when a user executes the * Pros: Will use less memory (e.g. for `delete`, just save the employee being deleted). * Cons: We must ensure that the implementation of each individual command are correct. -_{more aspects and alternatives to be added}_ ### \[Proposed\] Data archiving -_{Explain here how the data archiving feature will be implemented}_ +Copy the current ManageHR json file into a backup, with the appropriate name. +Load a new sample copy of ManageHR's data file. -------------------------------------------------------------------------------------------------------------------- @@ -370,8 +370,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `***` | Beginner user | There is a ‘help’ command to list functions/features | Know how to use the app | | `***` | Beginner user | Exception handling | Handle invalid inputs | | `***` | Intermediate user | Filter employee by parameters | Easily search/track certain details of employees | +| `***` | Intermediate user | Handle departments | Easily keep track of organizational structure | +| ***` | Intermediate user | Handle additional benefits like leave and salary | Easily keep track of organizational incentive programs. | -*{More to be added}* ### Use cases @@ -537,7 +538,14 @@ testers are expected to do more *exploratory* testing. 1. Re-launch the app by double-clicking the jar file.
Expected: The most recent window size and location is retained. -1. _{ more test cases …​ }_ +### Help function +1. Calling help + 1. With ManageHR open, type `help` into the command line. + Expected: A help window containing a link to the user guide, and a copy button shows. + +2. Calling help with a custom command. + 1. With ManageHR open, type `help add` into the command line. + Expected: A help window containing syntax, as well as an example should be visible to the user. The UI should be scaled such that everything can be seen. The copy button now takes on the command example. ### Deleting an employee @@ -582,6 +590,5 @@ testers are expected to do more *exploratory* testing. 1. Dealing with missing/corrupted data files - 1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_ - -1. _{ more test cases …​ }_ + 1. Modify `ManageHr.json` illegally. This is by adding illegal json tags, or destruction of the json structure. + 2. ManageHR will sense an issue, and replace the working file with the sample dataset. From d3fb47ca9786f6b0efc7032c1105e63af95ba3c1 Mon Sep 17 00:00:00 2001 From: Matthew Sung Date: Tue, 14 Nov 2023 12:03:39 +0800 Subject: [PATCH 3/4] More cleanup to the DG --- docs/DeveloperGuide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 2f81ccdb893..66f83ce08cf 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -9,7 +9,9 @@ title: Developer Guide ## **Acknowledgements** -* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} +This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). + +Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5) -------------------------------------------------------------------------------------------------------------------- @@ -562,7 +564,6 @@ testers are expected to do more *exploratory* testing. 1. Other incorrect delete commands to try: `delete`, `delete x`, `...` (where x is larger than the list size)
Expected: Similar to previous. -1. _{ more test cases …​ }_ ### Filtering From 297336e64c2d2d01d104b67698ba3bbffc159231 Mon Sep 17 00:00:00 2001 From: Matthew Sung Date: Tue, 14 Nov 2023 12:06:19 +0800 Subject: [PATCH 4/4] Fix typo --- docs/DeveloperGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 66f83ce08cf..de49f1090d1 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -373,7 +373,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `***` | Beginner user | Exception handling | Handle invalid inputs | | `***` | Intermediate user | Filter employee by parameters | Easily search/track certain details of employees | | `***` | Intermediate user | Handle departments | Easily keep track of organizational structure | -| ***` | Intermediate user | Handle additional benefits like leave and salary | Easily keep track of organizational incentive programs. | +| `**` | Intermediate user | Handle additional benefits like leave and salary | Easily keep track of organizational incentive programs. | ### Use cases