Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PED Bugs Issues 240 - 256 Improvements #308

Merged
merged 22 commits into from
Nov 12, 2024
Merged

PED Bugs Issues 240 - 256 Improvements #308

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
311d099
Delete PPP
AbdulrahmanAlRammah Nov 11, 2024
239d848
Clarify seed command message in UG
AbdulrahmanAlRammah Nov 11, 2024
d27c514
Improve disclaimer look
AbdulrahmanAlRammah Nov 11, 2024
e8efa4c
Clarify sort order in UG
AbdulrahmanAlRammah Nov 11, 2024
9a00b96
Move contact field requirements up
AbdulrahmanAlRammah Nov 11, 2024
519a1dc
Account for list error message in planned enhancements
AbdulrahmanAlRammah Nov 11, 2024
b7ae3f4
Fix typos in User Stories
AbdulrahmanAlRammah Nov 11, 2024
bc9f2eb
Update the find command tag _ in planned enhancements
AbdulrahmanAlRammah Nov 11, 2024
79e7ab9
Improve UG description of SocialBook
AbdulrahmanAlRammah Nov 11, 2024
1d17b96
Merge branch 'master' into PED_Bugs
AbdulrahmanAlRammah Nov 11, 2024
815be58
Add DG blank line EOF
AbdulrahmanAlRammah Nov 11, 2024
6da5d10
Fix DG typos
AbdulrahmanAlRammah Nov 11, 2024
7adbb31
Improve formatting
AbdulrahmanAlRammah Nov 12, 2024
82c541a
Merge branch 'master' into PED_Bugs
AbdulrahmanAlRammah Nov 12, 2024
bf7eac2
Update User Stories
AbdulrahmanAlRammah Nov 12, 2024
2fb7f5f
Merge branch 'master' into PED_Bugs
AbdulrahmanAlRammah Nov 12, 2024
e5b31c0
Merge branch 'master' into PED_Bugs
AbdulrahmanAlRammah Nov 12, 2024
93a0c18
Fix typo
AbdulrahmanAlRammah Nov 12, 2024
d5585d0
Add Remark enhancement
AbdulrahmanAlRammah Nov 12, 2024
018a061
Remove the C from class diagram
AbdulrahmanAlRammah Nov 12, 2024
e8b263d
Fix missing changes for contact field requirements
AbdulrahmanAlRammah Nov 12, 2024
dac12f8
Fix typos
AbdulrahmanAlRammah Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/AboutUs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
<img src="images/abdulrahmanalrammah.png" width="200px">

[[github](http://github.com/abdulrahmanalrammah)]
[[portfolio](team/abdulrahmanalrammah.md)]

* Role: Developer
* Responsibilities: Documentation
Expand Down
83 changes: 45 additions & 38 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,42 +289,42 @@ _{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…​ |
|----------|-------------------------------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| `* * *` | 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 SocialBook 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 |
| `* *` | new user | see a sample of the product features on display | so that I know how a feature can be used to maximise the value |
| `*` | 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 SocialBook 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 |
| 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 does 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 | 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 | have another way of reaching the beneficiary |
| `* *` | 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 SocialBook 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 |
| `* *` | new user | see a sample of the product features on display | so that I know how a feature can be used to maximise the value |
| `*` | has rotating beneficiaries | remove several contacts at once, when beneficiaries no longer require care | so that I can make space for new beneficiaries 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 SocialBook 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 |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you think about the suggestion i made under issue #305

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tbh I think we should just stick to this. Not much of a difference and I believe the "so that I can is what was taught in class".



*{More to be added}*
Expand Down Expand Up @@ -533,8 +533,8 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
* **Singapore Standard Time**: Singapore time, which is 8 hours ahead of Coordinated Universal Time (UTC + 08:00)
* **Hard disk**: data storage device in laptops and computers.
* **.JSON file**: JavaScript Object Notation, stores and transports data using a human-readable text format.
* **SocialBook**: SocialBook is an address book hence SocialBook and AddressBook are interchangable. SocialBook is used to reference the product while AddressBook refers to the Class object in source code.
* **Social worker**: refers to full-time employees of the [Ministry of Social and Family Developement (MSF) or its subsidaries](https://www.msf.gov.sg)
* **SocialBook**: SocialBook is an address book hence SocialBook and AddressBook are interchangeable. SocialBook is used to reference the product while AddressBook refers to the Class object in source code.
* **Social worker**: refers to full-time employees of the [Ministry of Social and Family Development (MSF) or its subsidiaries](https://www.msf.gov.sg)

--------------------------------------------------------------------------------------------------------------------

Expand Down Expand Up @@ -628,3 +628,10 @@ testers are expected to do more *exploratory* testing.
3. Remove `"remark"` field from a person. Expected: The person with the missing `"remark"` field is lost. The rest of the contacts still exist in the contact list.

4. Add a `","` to the `"remark"` field of a person. Expected: The file data format is invalid. All data is lost. The app starts on clean slate.

--------------------------------------------------------------------------------------------------------------------

## **Appendix: Planned Enhancements**

1. Make list command with miscellaneous parameters error message more helpful. Currently, typing list with miscellaneous parameters, ex. `list 123`, will result in a message that states "Please ensure your command is valid!". To improve specificity this will be changed to ask user to remove miscellaneous parameters.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it would be nice to wrap list in backticks

2. Prevent tags from allowing underscores. When searching for tags with underscores in the find command, the underscores are interpreted as an `or`. This means that searching for the tag "low_income" will bring up all tags containing "low" and "income" instead of just "low_income".
Loading