From da28eab7bb8d62a2098f1946d1465508f231a7cf Mon Sep 17 00:00:00 2001 From: annabellekk Date: Thu, 3 Oct 2024 15:59:00 +0800 Subject: [PATCH 1/3] Add acknowledgement to AB3 --- docs/DeveloperGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 743c65a49d2..e6e8bcb6995 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -9,7 +9,7 @@ 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). -------------------------------------------------------------------------------------------------------------------- From 311d5efea3bbafbf4ece2cb00428c56e6b04da0a Mon Sep 17 00:00:00 2001 From: annabellekk Date: Thu, 3 Oct 2024 16:15:57 +0800 Subject: [PATCH 2/3] Add user stories and use cases --- docs/DeveloperGuide.md | 43 ++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index e6e8bcb6995..d5e389dc6cb 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -275,20 +275,43 @@ _{Explain here how the data archiving feature will be implemented}_ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*` -| Priority | As a …​ | I want to …​ | So that I can…​ | -| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- | -| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App | -| `* * *` | user | add a new person | | -| `* * *` | user | delete a person | remove entries that I no longer need | -| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list | -| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident | -| `*` | user with many persons in the address book | sort persons by name | locate a person easily | +| Priority | As a …​ | I want to …​ | So that I can…​ | +|----------|-----------------------------------|------------------------------------|-------------------------------------------------------------------------| +| `* * *` | administrator of a tuition centre | view all students' contact details | easily access everyone's details at one place?? | +| `* * *` | administrator of a tuition centre | add a new person | add new contacts for newly enrolled students | +| `* * *` | administrator of a tuition centre | delete a student | remove students that are no longer enrolled | +| `* * *` | administrator of a tuition centre | find a student by name | locate details of students without having to go through the entire list | +| `* *` | | | | +| `*` | new user | see what commands are available | refer to instructions when I forget how to use the App | +| `*` | administrator | add emergency contact to a student | quickly find out who to contact at once glance if the situation arises | *{More to be added}* ### 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 `AddressBook` and the **Actor** is the `administrator`, unless specified otherwise) + +**Use case: Add a person** + +**MSS** + +1. User requests to add a student +2. User provides the details of the student +3. AddressBook adds the person + + Use case ends. + + **Extensions** + +* 2a. The format of the details provided are incorrect. + * 2a1. AddressBook shows an error message. + * 2a2. AddressBook shows what the expected format should be. + + Use case resumes at step 2 +* 2b. The student entered has already been added. + * 2b1. AddressBook shows a message that there has already been an entry for the student. + + Use case resumes at step 2 **Use case: Delete a person** @@ -326,7 +349,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli ### Glossary * **Mainstream OS**: Windows, Linux, Unix, MacOS -* **Private contact detail**: A contact detail that is not meant to be shared with others +* **Administrator**: Tutors and admin staff at the tuition centre. -------------------------------------------------------------------------------------------------------------------- From ccb6fc2d821d0dcfaf4c82e4eabb600211966ee8 Mon Sep 17 00:00:00 2001 From: annabellekk Date: Thu, 3 Oct 2024 22:19:17 +0800 Subject: [PATCH 3/3] Fix MSS steps --- docs/DeveloperGuide.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index d5e389dc6cb..106106f80b9 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -304,12 +304,11 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli **Extensions** * 2a. The format of the details provided are incorrect. - * 2a1. AddressBook shows an error message. - * 2a2. AddressBook shows what the expected format should be. + * 2a1. AddressBook requests input in correct format. Use case resumes at step 2 * 2b. The student entered has already been added. - * 2b1. AddressBook shows a message that there has already been an entry for the student. + * 2b1. AddressBook indicates that there has already been an entry for the student. Use case resumes at step 2