From c28535328f3fcf7bfad7dabd0c7c6c67b0c12b7a Mon Sep 17 00:00:00 2001 From: Rachael-Chan Date: Wed, 2 Oct 2024 18:50:41 +0800 Subject: [PATCH 1/2] docs: Update Use Case of SocialBook to DeveloperGuide.md --- docs/DeveloperGuide.md | 60 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 52 insertions(+), 8 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 9fe677d1e4c..a2d69daa304 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -300,16 +300,60 @@ 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 `SocialBook` and the **Actor** is the `user`, unless specified otherwise) -**Use case: Delete a person** +**Use case: View all contacts** **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 requests to list contacts +2. SocialBook shows a list of contacts + + Use case ends. + +**Extensions** + +* 2a. The list is empty. + + Use case ends. + +**Use case: Add a contact** + +**MSS** + +1. User requests to add a contact into the list with the specified details +2. SocialBook adds the contact and displays the newly added contact + + Use case ends. + +**Extensions** + +* 2a. The given specified details is empty. + + * 2a1. SocialBook shows an error message. + + Use case ends. + +* 3a. The given name and phone number is detected as duplicate. + + * 3a1. SocialBook shows an error message. + + Use case ends. + +* 4a. There is an error in any of the specified details. + + * 4a1. SocialBook shows an error message. + + Use case ends. + +**Use case: Delete a contact** + +**MSS** + +1. User requests to list contacts +2. SocialBook shows a list of contacts +3. User requests to delete a specific contact in the list +4. SocialBook deletes the contact Use case ends. @@ -321,10 +365,10 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli * 3a. The given index is invalid. - * 3a1. AddressBook shows an error message. + * 3a1. SocialBook shows an error message. Use case resumes at step 2. - + *{More to be added}* ### Non-Functional Requirements From 9deb3ef5810a229569467697a304a662eda34922 Mon Sep 17 00:00:00 2001 From: Rachael-Chan Date: Thu, 3 Oct 2024 18:40:21 +0800 Subject: [PATCH 2/2] docs: Fix extension numbering 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 392d3323317..43b17a0d7d2 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -363,15 +363,15 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli Use case ends. -* 3a. The given name and phone number is detected as duplicate. +* 2b. The given name and phone number is detected as duplicate. - * 3a1. SocialBook shows an error message. + * 2b1. SocialBook shows an error message. Use case ends. -* 4a. There is an error in any of the specified details. +* 2c. There is an error in any of the specified details. - * 4a1. SocialBook shows an error message. + * 2c1. SocialBook shows an error message. Use case ends.