Skip to content

Commit

Permalink
Add inclusion to Use Cases
Browse files Browse the repository at this point in the history
  • Loading branch information
Darren159 committed Oct 4, 2023
1 parent 7b35027 commit f1636c3
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 45 deletions.
52 changes: 31 additions & 21 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -302,49 +302,59 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

(For all use cases below, the **System** is the `MedBook` and the **Actor** is the `user`, unless specified otherwise)

**Use case: Delete a patient**
**Use case: UC01 - Viewing help**

**MSS**

1. User requests to list patients
2. MedBook shows a list of patients
3. User requests to delete a specific patient in the list
4. MedBook deletes the patient
**Use case: UC02 - Adding a patient**

Use case ends.
**MSS**

**Extensions**
**Use case: UC03 - Listing all patient**

* 2a. The list is empty.
**MSS**

Use case ends.
**Use case: UC04 - Editing a patient**

* 3a. The given id is invalid.
**MSS**

* 3a1. MedBook shows an error message.
**Use case: UC05 - Locating a specific patient**

Use case resumes at step 2.
**MSS**

**Use case: Pin a patient**
**Use case: UC06 - Delete a patient**

**MSS**

1. User requests to list patients
2. MedBook shows a list of patients
3. User requests to pin a specific patient in the list
4. MedBook pins the patient
1. User <u>lists all patients (UC03)</u>
2. User requests to delete a specific patient in the list
3. MedBook deletes the patient

Use case ends.

**Extensions**

* 2a. The list is empty.
* ~~2a. The given id is invalid.

* 2a1. MedBook shows an error message.~~

Use case ends.
Use case resumes at step 2.

**Use case: UC07 - Pin a patient**

**MSS**

1. User <u>lists all patients (UC03)</u>
2. User requests to pin a specific patient in the list
3. MedBook pins the patient

Use case ends.

**Extensions**

* 3a. The given id is invalid.
* 2a. The given id is invalid.

* 3a1. MedBook shows an error message.
* 2a1. MedBook shows an error message.

Use case resumes at step 2.

Expand Down
27 changes: 3 additions & 24 deletions docs/team/darren159.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,17 @@ AddressBook - Level 3 is a desktop address book application used for teaching So

Given below are my contributions to the project.

* **New Feature**: Added the ability to undo/redo previous commands.
* What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
* Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
* Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
* Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*

* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
* **New Feature**:

* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=darren159&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)

* **Project management**:
* Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub

* **Enhancements to existing features**:
* Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
* Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())


* **Documentation**:
* User Guide:
* Added documentation for the features `delete` and `find` [\#72]()
* Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
* Developer Guide:
* Added implementation details of the `delete` feature.

* **Community**:
* PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
* Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
* Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
* Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())

* **Tools**:
* Integrated a third party library (Natty) to the project ([\#42]())
* Integrated a new Github plugin (CircleCI) to the team repo

* _{you can add/remove categories in the list above}_

0 comments on commit f1636c3

Please sign in to comment.