From c3c88bb48f371a6a3bce3fa941548e8c0a26f0a5 Mon Sep 17 00:00:00 2001 From: liauzhanyi Date: Tue, 1 Oct 2024 21:30:13 +0800 Subject: [PATCH 1/6] Fix image extension --- ...hmanalrammah.png.jpg => abdulrahmanalrammah.png} | Bin 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/images/{abdulrahmanalrammah.png.jpg => abdulrahmanalrammah.png} (100%) diff --git a/docs/images/abdulrahmanalrammah.png.jpg b/docs/images/abdulrahmanalrammah.png similarity index 100% rename from docs/images/abdulrahmanalrammah.png.jpg rename to docs/images/abdulrahmanalrammah.png From 32abb21f3283405ce65ad30949b2029e158ea069 Mon Sep 17 00:00:00 2001 From: liauzhanyi Date: Tue, 1 Oct 2024 21:32:15 +0800 Subject: [PATCH 2/6] Add Liau Zhan Yi's project portfolio page --- docs/AboutUs.md | 8 ++++++++ docs/team/liauzhanyi.md | 12 ++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/team/liauzhanyi.md diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 870004b900a..1dba2ae99d9 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -48,3 +48,11 @@ You can reach us at the email `seer[at]comp.nus.edu.sg` * Role: Software Engineer * Responsibilities: In charge of `Model` +### Liau Zhan Yi + + + +[[github](https://github.com/liauzhanyi)] +[[portfolio](team/liauzhanyi.md)] + +* Role: Integration diff --git a/docs/team/liauzhanyi.md b/docs/team/liauzhanyi.md new file mode 100644 index 00000000000..25d6decc6c2 --- /dev/null +++ b/docs/team/liauzhanyi.md @@ -0,0 +1,12 @@ +--- + layout: default.md + title: "Liau Zhan Yi's Project Portfolio Page" +--- + +### Project: AddressBook Level 3 + +AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. + +Given below are my contributions to the project. + +* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2425s1.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-09-20) \ No newline at end of file From b32e84f04dcb87a852e9b8e2aef834ee71f24b10 Mon Sep 17 00:00:00 2001 From: liauzhanyi Date: Tue, 1 Oct 2024 22:02:43 +0800 Subject: [PATCH 3/6] Update README.md --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e225e17340d..a4e31566226 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,17 @@ ![Ui](docs/images/Ui.png) -* This is **a sample project for Software Engineering (SE) students**.
+* This is **an address book for social workers**.
Example usages: - * as a starting point of a course project (as opposed to writing everything from scratch) - * as a case study -* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details. + * as an easy way to locate/contact families. + * keep track of how long it has been since their last visit. + +* The project simulates an ongoing software project for a desktop application (called _SocialBook_) used for managing contact details. + * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big. * It comes with a **reasonable level of user and developer documentation**. -* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...). -* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**. -* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org/#contributing-to-se-edu) for more info. + +* For the detailed documentation of this project, see the **[SocialBook Product Website](https://ay2425s1-cs2103-f10-2.github.io/tp)**. + +## Acknowledgements +This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org). From e9cf2e9d687a18ee16cc9497bb5f8c7850884228 Mon Sep 17 00:00:00 2001 From: liauzhanyi Date: Tue, 1 Oct 2024 22:09:15 +0800 Subject: [PATCH 4/6] Update GitHub repository link in default layout --- docs/_markbind/layouts/default.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_markbind/layouts/default.md b/docs/_markbind/layouts/default.md index ea16467e280..18086f29834 100644 --- a/docs/_markbind/layouts/default.md +++ b/docs/_markbind/layouts/default.md @@ -9,7 +9,7 @@
  • User Guide
  • Developer Guide
  • About Us
    • -
  • :fab-github: +
  • :fab-github:
  • From 3836aa7f27375072f35929822f58eb543cf99af3 Mon Sep 17 00:00:00 2001 From: AbdulrahmanAlRammah <142239643+AbdulrahmanAlRammah@users.noreply.github.com> Date: Tue, 1 Oct 2024 22:47:14 +0800 Subject: [PATCH 5/6] Add User Stories --- docs/DeveloperGuide.md | 45 ++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 9fe677d1e4c..17fbe0d21c3 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -287,14 +287,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…​ | +|----------|-------------------------------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| +| `* * *` | social worker | delete a contact | remove the contact when I no longer serve them so that the contact list do not get too long | +| `* * *` | social worker/new user | add contact with phone number | remember the person i serve | +| `* * *` | social worker/new user | add address | easily look up without needed to look up database/files | +| `* * *` | social worker | view my list of contacts | so that i can see the beneficiaries i serve | +| `* *` | Overwhelmed with many households | Take note of how long it has been since I visited each house | Ensure that no house gets forgotten in my scheduling | +| `* *` | New user learning the interface | Check out basic commands that are frequently used with a help command | Learn the basic usage of the program more quickly | +| `* *` | User with multiple contacts per household | Tag multiple users to be from the same household | Simplify the process of contacting other household members | +| `* *` | social worker | prioritize contacts | allow myself to have quick access to high priority household | +| `* *` | social worker | add alternative contact method | add a contact for elderly who do not have a phone | +| `* *` | social worker/expert user | look for emergency contact quickly | inform next-of-kin when something happen | +| `* *` | social worker/expert user | add family contact | know how many people in the household | +| `* *` | social worker/expert user | add notes | remember if i need to take precaution before visiting the person/family or preparations i need to make | +| `* *` | social worker/expert user | sort contacts by lexicographical order | find contact quickly if i remember the name | +| `* *` | social worker/expert user | search through contacts using keywords | find contact quickly based on key words within the contact information | +| `* *` | social worker/expert user | add alternative phone number | incase beneficiary cannot be reached | +| `* *` | social worker/new user | edit contact | edit the contact without the need to delete and create a new one | +| `* *` | forgetful individual | add tags which explain what service the person needs | remember and be able to meet the needs of beneficiaries | +| `* *` | holder of sensitive information | lock the addressbook behind a password | avoid having unsolicited sharing of personal information | +| `* *` | Max | add the medicinal information of beneficiaries | to know when to follow up on critical medicines | +| `*` | Has rotating beneficiaries | remove several contacts at once, when beneficiaries no longer require care | so that I can make space for new benficiaries and not keep track of old ones | +| `*` | Max | know the households I need to visit on a certain day | so that I can schedule my day and not forget to visit any households | +| `*` | Short on time | Visit households that are geographically close in the same day/visit | Minimise the travelling time for myself | +| `*` | User switching devices | Transfer the address book contacts from one device to another | Avoid having to manually re-enter all the current contacts | +| `*` | Max/expert user | export all contacts to a txt file/excel file | so that I have a copy of all beneficiaries, past and present, in a larger database | +| `*` | Max/expert user | record social media credentials of a contact, if they have any | so that I can get to know their lives better and establish a closer bond | +| `*` | Max/expert user | send reminder to my email a day before my visit | so that I will not forget to visit a household | +| `*` | Max/expert user | upload pictures of my beneficiaries | so that I will not forget how they look like | +| `*` | Max/expert user | view contacts on google maps | so that I can directly see where and how to go to the household | +| `*` | visual rememberer | add photos for each contact | to match beneficiary names to their faces more easily | +| `*` | loyal user | save contact information into a shareable form | share contacts with colleagues as need be | +| `*` | experienced social worker | locate a link where I can share my views and suggestions on the app | help the app be more user centered and helpful over time | +| `*` | efficient person | create visit paths based on proximity of beneficiaries | to be able to serve the most beneficiaries a day | +| `*` | social person | add notes of on conversations with beneficiaries | develop stronger relationships by building rapport | + + *{More to be added}* From 5031833e2b69b5ac001c1d874a6bdd427b925ace Mon Sep 17 00:00:00 2001 From: AbdulrahmanAlRammah <142239643+AbdulrahmanAlRammah@users.noreply.github.com> Date: Wed, 2 Oct 2024 20:35:57 +0800 Subject: [PATCH 6/6] Standardize user stories format --- docs/DeveloperGuide.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 17fbe0d21c3..3dd670b32cd 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -293,9 +293,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* * *` | social worker/new user | add contact with phone number | remember the person i serve | | `* * *` | social worker/new user | add address | easily look up without needed to look up database/files | | `* * *` | social worker | view my list of contacts | so that i can see the beneficiaries i serve | -| `* *` | Overwhelmed with many households | Take note of how long it has been since I visited each house | Ensure that no house gets forgotten in my scheduling | -| `* *` | New user learning the interface | Check out basic commands that are frequently used with a help command | Learn the basic usage of the program more quickly | -| `* *` | User with multiple contacts per household | Tag multiple users to be from the same household | Simplify the process of contacting other household members | +| `* *` | overwhelmed with many households | take note of how long it has been since I visited each house | ensure that no house gets forgotten in my scheduling | +| `* *` | new user learning the interface | check out basic commands that are frequently used with a help command | learn the basic usage of the program more quickly | +| `* *` | user with multiple contacts per household | tag multiple users to be from the same household | simplify the process of contacting other household members | | `* *` | social worker | prioritize contacts | allow myself to have quick access to high priority household | | `* *` | social worker | add alternative contact method | add a contact for elderly who do not have a phone | | `* *` | social worker/expert user | look for emergency contact quickly | inform next-of-kin when something happen | @@ -307,16 +307,16 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli | `* *` | social worker/new user | edit contact | edit the contact without the need to delete and create a new one | | `* *` | forgetful individual | add tags which explain what service the person needs | remember and be able to meet the needs of beneficiaries | | `* *` | holder of sensitive information | lock the addressbook behind a password | avoid having unsolicited sharing of personal information | -| `* *` | Max | add the medicinal information of beneficiaries | to know when to follow up on critical medicines | -| `*` | Has rotating beneficiaries | remove several contacts at once, when beneficiaries no longer require care | so that I can make space for new benficiaries and not keep track of old ones | -| `*` | Max | know the households I need to visit on a certain day | so that I can schedule my day and not forget to visit any households | -| `*` | Short on time | Visit households that are geographically close in the same day/visit | Minimise the travelling time for myself | -| `*` | User switching devices | Transfer the address book contacts from one device to another | Avoid having to manually re-enter all the current contacts | -| `*` | Max/expert user | export all contacts to a txt file/excel file | so that I have a copy of all beneficiaries, past and present, in a larger database | -| `*` | Max/expert user | record social media credentials of a contact, if they have any | so that I can get to know their lives better and establish a closer bond | -| `*` | Max/expert user | send reminder to my email a day before my visit | so that I will not forget to visit a household | -| `*` | Max/expert user | upload pictures of my beneficiaries | so that I will not forget how they look like | -| `*` | Max/expert user | view contacts on google maps | so that I can directly see where and how to go to the household | +| `* *` | max/expert user | add the medicinal information of beneficiaries | to know when to follow up on critical medicines | +| `*` | has rotating beneficiaries | remove several contacts at once, when beneficiaries no longer require care | so that I can make space for new benficiaries and not keep track of old ones | +| `*` | max/expert user | know the households I need to visit on a certain day | so that I can schedule my day and not forget to visit any households | +| `*` | user short on time | visit households that are geographically close in the same day/visit | minimise the travelling time for myself | +| `*` | user switching devices | transfer the address book contacts from one device to another | avoid having to manually re-enter all the current contacts | +| `*` | max/expert user | export all contacts to a txt file/excel file | so that I have a copy of all beneficiaries, past and present, in a larger database | +| `*` | max/expert user | record social media credentials of a contact, if they have any | so that I can get to know their lives better and establish a closer bond | +| `*` | max/expert user | send reminder to my email a day before my visit | so that I will not forget to visit a household | +| `*` | max/expert user | upload pictures of my beneficiaries | so that I will not forget how they look like | +| `*` | max/expert user | view contacts on google maps | so that I can directly see where and how to go to the household | | `*` | visual rememberer | add photos for each contact | to match beneficiary names to their faces more easily | | `*` | loyal user | save contact information into a shareable form | share contacts with colleagues as need be | | `*` | experienced social worker | locate a link where I can share my views and suggestions on the app | help the app be more user centered and helpful over time |