From a3f2efb36fae29426785f1d92b7f5bdc1d3e320c Mon Sep 17 00:00:00 2001 From: nigel Date: Wed, 6 Mar 2024 18:49:56 +0800 Subject: [PATCH 1/3] Add Use Cases to Developer Guide --- docs/DeveloperGuide.md | 124 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 117 insertions(+), 7 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 1b56bb5d31b..b3b3461546c 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -288,16 +288,126 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Use cases -(For all use cases below, the **System** is the `AddressBook` and the **Actor** is the `user`, unless specified otherwise) +(For all use cases below, the **System** is the `Strack.io` and the **Actor** is the `user`, unless specified otherwise) -**Use case: Delete a person** +**Use case: UC1 - Adding a contact** **MSS** -1. User requests to list persons -2. AddressBook shows a list of persons -3. User requests to delete a specific person in the list -4. AddressBook deletes the person +1. User chooses to add a new customer and specifies the required details. +2. Strack.io displays the added customer contact. + + Use case ends. + +**Extensions** + +* 1a. Strack.io detects an error in the entered data. + * 1a1. Strack.io shows the missing/incorrect field. + * 1a2. User enters new data. + + Steps 1a1-1a2 are repeated until the data entered are correct. + + Use case resumes from step 2. + +**Use case: UC2 - Delete a contact** + +**MSS** + +1. User requests to list persons. +2. Strack.io shows a list of persons. +3. User requests to delete a specific person in the list. +4. Strack.io requests for confirmation. +5. User confirms. +6. Strack.io deletes the contact, displaying the deleted contact. + + Use case ends. + +**Extensions** + +* 2a. The list is empty. + + Use case ends. + +* 3a. The given index is invalid. + + * 3a1. Strack.io shows an error message. + + Use case resumes at step 2. + +**Use case: UC3 - Edit a contact** + +**MSS** + +1. User requests to list persons. +2. Strack.io shows a list of persons. +3. User requests to edit the details of a specific person in the list. +4. Strack.io edits the details of the person and displays the new contact. + + Use case ends. + +**Extensions** + +* 2a. The list is empty. + + Use case ends. + +* 3a. The given index is invalid. + + * 3a1. Strack.io shows an error message. + + Use case resumes at step 2. + +* 3b. Strack.io detects an error in the entered data. + * 3b1. Strack.io shows the missing/incorrect field. + * 3b2. User enters new data. + + Steps 3b1-3b2 are repeated until the data entered are correct. + + Use case resumes from step 4. + +**Use case: UC4 - Searching for a contact** + +**MSS** + +1. User requests to search for contact based on keyword. +2. Strack.io shows a list of matching persons. + + Use case ends. + +**Extensions** +* 2a. The list of matching persons is empty. + + Use case ends. + +**Use case: UC5 - Creating an order** + +**MSS** + +1. User chooses to create an order for an existing person and specifies the required details. +2. Strack.io displays the added order. + + Use case ends. + +**Extensions** + +* 1a. Strack.io detects an error in the entered data. + * 1a1. Strack.io shows the missing/incorrect field. + * 1a2. User enters new data. + + Steps 1a1-1a2 are repeated until the data entered are correct. + + Use case resumes from step 2. + +**Use case: UC6 - Delete an order** + +**MSS** + +1. User requests to list orders. +2. Strack.io shows a list of orders. +3. User requests to delete a specific order in the list. +4. Strack.io requests for confirmation. +5. User confirms. +6. Strack.io deletes the order, displaying the deleted order. Use case ends. @@ -309,7 +419,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 3a. The given index is invalid. - * 3a1. AddressBook shows an error message. + * 3a1. Strack.io shows an error message. Use case resumes at step 2. From c88c0dccf094a9a38c3c3f703c6412e4112c57da Mon Sep 17 00:00:00 2001 From: nigel Date: Thu, 7 Mar 2024 12:03:20 +0800 Subject: [PATCH 2/3] Fix Style Check Mistakes in DeveloperGuide.md --- docs/DeveloperGuide.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index b3b3461546c..31a0ff4edbe 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -306,7 +306,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 1a2. User enters new data. Steps 1a1-1a2 are repeated until the data entered are correct. - + Use case resumes from step 2. **Use case: UC2 - Delete a contact** @@ -356,13 +356,13 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 3a1. Strack.io shows an error message. Use case resumes at step 2. - + * 3b. Strack.io detects an error in the entered data. * 3b1. Strack.io shows the missing/incorrect field. * 3b2. User enters new data. - + Steps 3b1-3b2 are repeated until the data entered are correct. - + Use case resumes from step 4. **Use case: UC4 - Searching for a contact** From 9392adf069991ed83df521e384a452b9e5641771 Mon Sep 17 00:00:00 2001 From: nigel Date: Thu, 7 Mar 2024 12:12:28 +0800 Subject: [PATCH 3/3] Fix Readme.md stylecheck --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d11b339ff49..361c3618255 100644 --- a/README.md +++ b/README.md @@ -22,4 +22,4 @@ **Acknowledgements** * Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5) -* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). \ No newline at end of file +* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).