Skip to content

Commit

Permalink
Merge pull request #172 from qz1004/update-docs3
Browse files Browse the repository at this point in the history
Add parameter tables to UG and update other docs
  • Loading branch information
juzzztinsoong authored Nov 12, 2023
2 parents 2c6aca4 + 1b7b84a commit b4e0deb
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 75 deletions.
3 changes: 0 additions & 3 deletions docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@

We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).

You can reach us at the email `seer[at]comp.nus.edu.sg`

## Project team

### Cheong Howen
Expand Down Expand Up @@ -33,7 +31,6 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`

<img src="images/qz1004.png" width="200px">


[[github](http://github.com/qz1004)]
[[portfolio](team/qz1004.md)]

Expand Down
25 changes: 22 additions & 3 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,8 +329,9 @@ The following diagrams show the entire sequence flow for `LogicManager#execute()
User can specify a Person to add as an Attendee to a specified Meeting.

To avoid storing an entire `JsonAdaptedPerson` object within the `JsonAdaptedMeeting` every time a `Person` is added to a `Meeting`,
we created the `Attendee` class to store a unique identifier for the `Person` added.
As every `Person` has a unique name in the current iteration, `Attendee` is implemented in the following way:
an `Attendee` class is created to store a unique identifier for the `Person` added.
As every `Person` has a unique name in the current iteration of OutBook, it is used as the unique identifier.
`Attendee` is implemented in the following way:

- `Attendee(attendeeName)` -- Initialized with a String obtained from `Person.getName().toString()`
- `Attendee#getAttendeeName()` -- Returns a String representing the attendee's name
Expand All @@ -341,7 +342,7 @@ The following sequence diagram shows how the add attendee operation works:

![AddAttendeeSequenceDiagram](images/AddAttendeeSequenceDiagram.png)

A Person object can be obtained from a Meeting's list of attendees by searching through `UniquePersonList`
A `Person` object can be obtained from a `Meeting`'s list of attendees by searching through `UniquePersonList`
for a `Person` with a name matching `attendeeName`.

<div style="page-break-after: always;"></div>
Expand Down Expand Up @@ -388,6 +389,24 @@ This is facilitated by the addition of the `MarkDoneCommand`. When a meeting is

<div style="page-break-after: always;"></div>

### Keeping track of the status of a contact
Each instance of `Person` contains an immutable `Status` object that allows the user to specify which stage of the insurance sales process a contact is at, if applicable.
At the current iteration of OutBook, a status must be one of `NIL`, `Prospective`, `Active`, `Inactive`, `Renewal`, `Claimant` (case-insensitive).
This is tailored according to the responsibilities of an insurance agent, which include:
- Promoting relevant insurance policies to prospective clients
- Keeping active clients updated on their policies
- Finding out why inactive clients did not renew their policies
- Sending renewal reminders to clients whose policies are approaching expiry
- Filing and following up on claims on behalf of their clients

The list of valid statuses is stored as an `Enumeration` object for the following benefits:
- Readability: e.g. `StatusList.NIL` is self-explanatory and easier to understand than something like `StatusList[0]` if an index data structure were to be used.
- Maintainability: If the list of valid statuses changes or expands in the future, it's much easier to update an enumeration. This centralizes the changes in one place, making the code more maintainable compared to scattered string constants.

`Status` is implemented and utilized in a similar manner to [`LastContactedTime`](#keeping-track-of-last-meeting-with-contact).

<div style="page-break-after: always;"></div>

## **Planned Enhancements**

### \[Proposed\] Undo and redo feature
Expand Down
Loading

0 comments on commit b4e0deb

Please sign in to comment.