PED Bugs Issues 240 - 256 Improvements #308
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
This was referenced Nov 11, 2024
liauzhanyi
requested changes
Nov 11, 2024
docs/DeveloperGuide.md
Outdated
Comment on lines
292
to
327
| | 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 | |
There was a problem hiding this comment.
what do you think about the suggestion i made under issue #305
There was a problem hiding this comment.
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".
docs/DeveloperGuide.md
Outdated
|
|
||
| ## **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. |
There was a problem hiding this comment.
i think it would be nice to wrap list in backticks
docs/UserGuide.md
Outdated
|
|
||
| ### Date of Last Visit | ||
| * Dates of last visit are optional for contacts, and are denoted by the `d/` prefix. | ||
| * Dates of last visit are confined to the `DD-MM-YYYY` format. |
There was a problem hiding this comment.
should we change this to dd-MM-yyyy like in the gui message for consistency? since we can't change what is on the app.
There was a problem hiding this comment.
Yeah can I think rayner's PR does this, but let me double check.
# Conflicts: # docs/DeveloperGuide.md # docs/UserGuide.md
# Conflicts: # docs/UserGuide.md
# Conflicts: # docs/UserGuide.md
liauzhanyi
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is for updating information associated to the issues 240 - 256 from PED.
Closes #242
Since its a UG talking about project objectives doesn't make sense. However, I add lines in the beginning to explain how social book benefits our target user (social worker in Singapore).
Closes #244
Clarified that seed command doesn't inform the user on duplicate skipping in UG.
Closes #246
Mentioned in planned enhancements.
Closes #249
I explained the general sort order. I didn't mention ASCII because most users won't know it.
Closes #254
Moved the contact fields requirements up as this order makes more sense.
Closes #256
Added Planned enhancements appendix and mentioned improving the list error message to make it more helpful.
Closes #288 #302