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

Fix minor bugs in DG #219

Merged
merged 2 commits into from
Apr 15, 2024
Merged

Fix minor bugs in DG #219

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
547ddcf
Fix minor bugs in DG
youdonnnn Apr 15, 2024
3688cb6
Fix minor bugs in DG
youdonnnn Apr 15, 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
75 changes: 16 additions & 59 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

## **Acknowledgements**

_{ list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well }_
_ All ideas in this project are original

---

Expand Down Expand Up @@ -235,9 +235,9 @@ tag with the inputted policy name.

- **Alternative 1 (current choice):** Encompass the policy details into a single Policy class with the details
as attributes to the Policy class
_ Pros: Good abstraction level to organise all the policy information into one convenient class that can be
- Pros: Good abstraction level to organise all the policy information into one convenient class that can be
referenced and have its own methods.
_ Cons: Not as straightforward to implement and requires updating multiple classes
- Cons: Not as straightforward to implement and requires updating multiple classes

- **Alternative 2:** Individual policy details as their own attributes to Person object
itself.
Expand Down Expand Up @@ -376,18 +376,20 @@ These are some proposed features that can be implemented in the future.

### Product scope

**Target user profile**: An insurance Agent who
**Target user profile**: An insurance agent who

- has a need to manage a significant number of contacts and their policies
- has a need to manage a significant number of clients and keep track of each client's policies
- has a need for an all-in-one application to schedule his appointments and remind him of upcoming meetings
- prefer desktop apps over other types
- can type fast
- prefers typing to mouse interactions
- is reasonably comfortable using CLI apps
- Needs a one application to schedule his appointments and reminds him about it

**Value proposition**: Assist Insurance Agent keep track of their clients and new clients.
This provides them with a 1 application to add details about their clients insurance plans and
set reminders for meetups with clients.

**Value proposition**: InsureBook is an all-in-one application designed to allow Insurance Agents to keep track
of their client's personal information and policies. Our application also allows Insurance Agents to schedule
meetings with clients. With our application, Insurance Agents can centralise their workflows and achieve increased
work efficiency.

### User stories

Expand All @@ -411,7 +413,7 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

### Use cases

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

**Use case: UC01 - View help**

Expand All @@ -422,12 +424,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Extensions**

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC02 - Add a client**

**MSS**
Expand All @@ -451,10 +447,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes from step 1.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC03 - List all clients**

**MSS**
Expand All @@ -464,11 +456,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Extensions**

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC04 - Edit a client**

Expand Down Expand Up @@ -505,10 +492,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes at step 3.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC05 - View a client**

**MSS**
Expand All @@ -531,10 +514,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes at step 2.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC06 - Find a client**

**MSS**
Expand All @@ -552,9 +531,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes from step 1.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC07 - Add a policy**

Expand All @@ -572,15 +548,12 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

-2a. The given index is invalid.
- 2a. The given index is invalid.

- 2a1. InsureBook shows an error message.

Use case resumes from step 2.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC08 - Delete a policy**

Expand All @@ -598,21 +571,18 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

-2a. The given index is invalid.
- 2a. The given index is invalid.

- 2a1. InsureBook shows an error message.

Use case resumes from step 2.

-3a. The given policy number is invalid or does not exist
- 3a. The given policy number is invalid or does not exist

- 3a1. InsureBook shows an error message.

Use case resumes from step 2.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC09 - Find a policy**

Expand All @@ -630,16 +600,12 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

-2a. The given keyword is invalid.
- 2a. The given keyword is invalid.

- 2a1. InsureBook shows an error message.

Use case resumes from step 2.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC10 - Delete a client**

**MSS**
Expand All @@ -662,9 +628,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case resumes at step 2.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case: UC11 - View upcoming meetings for the present week**

Expand Down Expand Up @@ -698,9 +661,6 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

**Use case UC13: Exit program**

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

Use case ends.

\*a. At any time, user inputs an invalid command/syntax.

\*a1. InsureBook shows an error message.

### Non-Functional Requirements

Expand Down
Loading