Skip to content

Commit

Permalink
Merge branch 'AY2425S1-CS2103-F10-2:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
@rayray39
rayray39 authored Oct 2, 2024
2 parents 57857f0 + 4cc6c7a commit 5815885
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 26 deletions.
18 changes: 11 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@

![Ui](docs/images/Ui.png)

* This is **a sample project for Software Engineering (SE) students**.<br>
* This is **an address book for social workers**.<br>
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).
17 changes: 7 additions & 10 deletions docs/AboutUs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team


### Liau Zhan Yi

<img src="images/liauzhanyi.png" width="200px">

[[github](https://github.com/liauzhanyi)]
[[portfolio](team/liauzhanyi.md)]

* Role: Integration

### Andrew Teoh

<img src="images/andrew22teoh.png" width="200px">
Expand Down Expand Up @@ -58,4 +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

<img src="images/liauzhanyi.png" width="200px">

[[github](https://github.com/liauzhanyi)]
[[portfolio](team/liauzhanyi.md)]

* Role: Integration
45 changes: 37 additions & 8 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/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 |
| `*` | 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}*

Expand Down
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<li><a href="{{baseUrl}}/UserGuide.html" class="nav-link">User Guide</a></li>
<li><a href="{{baseUrl}}/DeveloperGuide.html" class="nav-link">Developer Guide</a></li>
<li><a href="{{baseUrl}}/AboutUs.html" class="nav-link">About Us</a></li>
<li><a href="https://github.com/se-edu/addressbook-level3" target="_blank" class="nav-link"><md>:fab-github:</md></a>
<li><a href="https://github.com/AY2425S1-CS2103-F10-2/tp" target="_blank" class="nav-link"><md>:fab-github:</md></a>
</li>
<li slot="right">
<form class="navbar-form">
Expand Down
0 docs/images/abdulrahmanalrammah.png.jpg → docs/images/abdulrahmanalrammah.png
View file
File renamed without changes

0 comments on commit 5815885

Please sign in to comment.