[CS2103T-F12-2] VISIT #64
Open
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
jon-chua
reviewed
Oct 4, 2019
docs/DeveloperGuide.adoc
Outdated
Comment on lines
302
to
314
| |`* * *` |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 |view the full profile of a patient by searching for his/her name |see all details regarding a patient easily | ||
|
|
||
| |`* * *` |user |record down details of each <<visitation,visitation>> |keep track of the patients situation | ||
|
|
||
| |`* * *` |user |have daily reminders of important deadlines |keep track of appointments and visitations easily | ||
|
|
||
| |`* * *` |user |set follow-up reminders |check in on my patients after some time or when their medication runs out | ||
|
|
||
| |`* * *` |user |have <<user-defined-macros,user-defined macros>> |streamline my diagnosis documentation | ||
|
|
||
| |`* *` |user |hide <<private-contact-detail,private contact details>> by default |minimize chance of someone else seeing them by accident |
There was a problem hiding this comment.
Some comments on your User Stories:
- The actors of your use cases are pretty general (user), maybe we could change them to something more descriptive and specific? (e.g. doctor)
- Try to add more user stories! 😄
- Great that you linked specific definitions to your glossary! 👍
| ** 2a. AddressBook shows no reminder message. | ||
| + | ||
| Use case ends. | ||
|
|
||
| _{More to be added}_ | ||
|
|
||
| [appendix] |
There was a problem hiding this comment.
Some comments on your NFRs:
- Try to update them soon! For example, we could rename persons to patients to make it more specific 😄
- Think of more specific NFRs tied to your application.
Raikonen
reviewed
Oct 4, 2019
| + | ||
| Use case ends. | ||
| [none] | ||
| * 3. The given name/index is invalid. |
docs/DeveloperGuide.adoc
Outdated
| * 3. The given name/index is invalid. | ||
| + | ||
| [none] | ||
| ** 3a. AddressBook shows an error message. |
| Use case resumes at step 2. | ||
|
|
||
| [none] | ||
| * 4. The profile is empty. |
docs/DeveloperGuide.adoc
Outdated
|
|
||
| 1. User requests to list persons | ||
| 2. AddressBook shows a list of persons | ||
| 3. User requests to add new visitation record for a specific patient in the list |
There was a problem hiding this comment.
Maybe it will be good to clarify whether the record added to a specific patient will be a custom one everytime, or just an empty one after it is requested by the user.
docs/DeveloperGuide.adoc
Outdated
|
|
||
| Use case resumes at step 1. | ||
|
|
||
| * 1b. There are multiple records with the same name and date |
There was a problem hiding this comment.
Will records with the same date and time but not same name be allowed?
docs/DeveloperGuide.adoc
Outdated
| * 1b. There are multiple records with the same name and date | ||
| + | ||
| [none] | ||
| ** 1b1. AddressBook shows list of records and prompts user to re-enter last command with index of record to delete. |
There was a problem hiding this comment.
If records with the same name or datetime are not allowed in the records, would this still be an issue?
| Use case resumes at step 1. | ||
|
|
||
| [discrete] | ||
| === Use case: Save user-defined macros |
There was a problem hiding this comment.
Might want to consider adding the definition of macro into the glossary
docs/DeveloperGuide.adoc
Outdated
| *Extensions* | ||
|
|
||
| [none] | ||
| * 2. No reminders are set to show |
There was a problem hiding this comment.
Extensions should start with 1 instead of 2
docs/DeveloperGuide.adoc
Outdated
| *Extensions* | ||
|
|
||
| [none] | ||
| * 2. No reminders are scheduled for the day |
There was a problem hiding this comment.
Extensions should start with 1 instead of 2
docs/DeveloperGuide.adoc
Outdated
| Use case ends. | ||
|
|
||
| [discrete] | ||
| === Use case: View follow-up reminders |
There was a problem hiding this comment.
Might want to consider adding the definition of follow-up reminders, and its difference with ordinary reminders into the glossary too!
chore: sync with team repo
chore: sync update-UGDG branch with team repo
docs: clean-up docs for documentation integrity
fixed heading
Update UG/DG, refactor unalias
docs: follow-up and reminders update
docs: added GUI redesign part in Implementation section of DevGuide docs: added Ui Redesign Class Diagram PlantUML file and image cleanup: Rename ProfilePanel to ProfileWindow to follow naming structure cleanup: added fxid to ReminderPanel for future use
…gUtil, ProfileUtil
fix: fixed bug where editvisit 1 i/-1 will not throw error fix: fixed the same bug for deletevisit
refactor!: refactor of `Profile` Component and Tests
docs:updated UG of new behavior for deletevisit and editvisit command
Refactor
chore: enum appointments
… into branch-alias-command
docs: update UG and PPP
docs: add PPP, update UG and DG
fix: adjust PPP for page limit
fix: refactoring artifacts
* Final Updates to UGDG docs: fix @Wingedevil link to PPP in About Us docs: Added Manual Testing Appendix to DG docs: Updated Ui image to reflect latest build docs: Standardised image sizes in UG small fix: made label focus untraversable in CommandBox
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.
Made change so that it's possible to do a PR to original repo