Skip to content

Commit

Permalink
Update DeveloperGuide.md and add PPP
Browse files Browse the repository at this point in the history
  • Loading branch information
Darren159 committed Oct 3, 2023
1 parent 7a35116 commit fcfb4ed
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 20 deletions.
56 changes: 42 additions & 14 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
pageNav: 3
---

# AB-3 Developer Guide
# MedBook Developer Guide

<!-- * Table of Contents -->
<page-nav-print />
Expand Down Expand Up @@ -35,7 +35,7 @@ Given below is a quick overview of main components and how they interact with ea

**Main components of the architecture**

**`Main`** (consisting of classes [`Main`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down.
**`Main`** (consisting of classes [`Main`](https://github.com/AY2324S1-CS2103T-T12-4/tp/blob/master/src/main/java/seedu/address/Main.java) and [`MainApp`](https://github.com/AY2324S1-CS2103T-T12-4/tp/blob/master/src/main/java/seedu/address/MainApp.java)) is in charge of the app launch and shut down.
* At app launch, it initializes the other components in the correct sequence, and connects them up with each other.
* At shut down, it shuts down the other components and invokes cleanup methods where necessary.

Expand Down Expand Up @@ -67,7 +67,7 @@ The sections below give more details of each component.

### UI component

The **API** of this component is specified in [`Ui.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/ui/Ui.java)
The **API** of this component is specified in [`Ui.java`](https://github.com/AY2324S1-CS2103T-T12-4/tp/blob/master/src/main/java/seedu/address/ui/Ui.java)

<puml src="diagrams/UiClassDiagram.puml" alt="Structure of the UI Component"/>

Expand Down Expand Up @@ -115,7 +115,7 @@ How the parsing works:
* All `XYZCommandParser` classes (e.g., `AddCommandParser`, `DeleteCommandParser`, ...) inherit from the `Parser` interface so that they can be treated similarly where possible e.g, during testing.

### Model component
**API** : [`Model.java`](https://github.com/se-edu/addressbook-level3/tree/master/src/main/java/seedu/address/model/Model.java)
**API** : [`Model.java`](https://github.com/AY2324S1-CS2103T-T12-4/tp/blob/master/src/main/java/seedu/address/model/Model.java)

<puml src="diagrams/ModelClassDiagram.puml" width="450" />

Expand Down Expand Up @@ -269,13 +269,18 @@ _{Explain here how the data archiving feature will be implemented}_

**Target user profile**:

* has a need to manage a significant number of contacts
* doctors
* has a need to manage a significant number of patients
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* is reasonably comfortable using CLI apps

**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
**Value proposition**:

* streamline patient management
* easy access to patients' details such as medical records and contact information
* manage patients faster than a typical mouse/GUI driven app


### User stories
Expand All @@ -295,16 +300,39 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

### Use cases

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

**Use case: Delete a patient**

**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 ends.

**Extensions**

* 2a. The list is empty.

Use case ends.

* 3a. The given id is invalid.

* 3a1. MedBook shows an error message.

Use case resumes at step 2.

**Use case: Delete a person**
**Use case: Pin a patient**

**MSS**

1. User requests to list persons
2. AddressBook shows a list of persons
3. User requests to delete a specific person in the list
4. AddressBook deletes the person
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

Use case ends.

Expand All @@ -314,9 +342,9 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

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

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

Use case resumes at step 2.

Expand Down
6 changes: 3 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# MedBook User Guide

Medbook (AB3) is a **desktop app for managing patient details and medical records, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, MedBook can get your contact management tasks done faster than traditional GUI apps.
Medbook is a **desktop app for managing patient details and medical records, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, MedBook can get your contact management tasks done faster than traditional GUI apps.

<!-- * Table of Contents -->
<page-nav-print />
Expand Down Expand Up @@ -209,9 +209,9 @@ Action | Format, Examples
-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
**Clear** | `clear`
**Delete** | `delete patientId`<br> e.g., `delete 3`
**Delete** | `delete [patientId]`<br> e.g., `delete 3`
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**Pin** | `pin patientId`<br> e.g., `pin 2`
**Pin** | `pin [patientId]`<br> e.g., `pin 2`
**List** | `list`
**Help** | `help`
6 changes: 3 additions & 3 deletions docs/team/darren159.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: default.md
title: "John Doe's Project Portfolio Page"
title: "Darren's Project Portfolio Page"
---

### Project: AddressBook Level 3
### Project: MedBook

AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.

Expand All @@ -17,7 +17,7 @@ Given below are my contributions to the project.

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

* **Code contributed**: [RepoSense link]()
* **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
Expand Down

0 comments on commit fcfb4ed

Please sign in to comment.