Skip to content

Commit

Permalink
Merge pull request #280 from cyaoxuan/cs2101-update-ug-2
Browse files Browse the repository at this point in the history
Update UserGuide.md
  • Loading branch information
cyaoxuan authored Nov 15, 2023
2 parents 9bc4ac8 + 448c877 commit 95aa75b
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ Welcome to the user guide for InsureIQ, the ultimate **contact management system
Additional information for your understanding.
</div>

<div markdown="block" class="alert alert-success">
<div markdown="span" class="alert alert-success">
**:bulb: Tips:**
Tips for you to maximise efficiency.
</div>

<div markdown="block" class="alert alert-warning">
<div markdown="span" class="alert alert-warning">
**:exclamation: Warnings:**
Important information you need to be careful about!
</div>
Expand Down Expand Up @@ -312,7 +312,7 @@ Error: The parameter is not of the type positive integer
Batch delete clients based on a specific condition.

<div markdown="span" class="alert alert-success">
**:bulb: Usefulness of `batchdelete`:**
**:bulb: Usage tip:**
Use `batchdelete` to quickly delete clients whose policies have expired, or for companies you are no longer working with.
</div>

Expand All @@ -335,7 +335,7 @@ Expected output upon success: <br>
![BatchDeleteSuccess](images/BatchDeleteSuccess.png)

<div markdown="span" class="alert alert-info">
**:information_source: Confirmation message**
**:information_source: Confirmation message:**
Even if no clients are deleted, InsureIQ will still show a confirmation message to let you know that the `batchdelete`
command has been successfully processed.
</div>
Expand Down Expand Up @@ -456,7 +456,8 @@ Clears all entries from your client list.
Format: `clear`

<div markdown="span" class="alert alert-warning">
**:exclamation: Caution:**This action is irreversible! You can copy the data file before clearing to have a backup.
**:exclamation: Caution:**
This action is irreversible! You can copy the data file before clearing to have a backup.
</div>


Expand Down Expand Up @@ -545,10 +546,13 @@ Sure! you can transfer your data to another computer by the following steps belo

## Glossary

_{TO DO}_
* **Command Line Interface (CLI)**: A way of interacting with the software by typing textual commands
* **Graphical User Interface (GUI)**: A way of interacting with the software using visual elements like buttons and windows
* **Policy fields**: Refers to the company the policy is under, policy number, policy issue date and policy expiry date
* **Client**: Buyers / potential buyers that car insurance agent is in contact with, such that it is stored inside InsureIQ
* **Client list**: List of clients and their personal and policy details in the InsureIQ app


--------------------------------------------------------------------------------------------------------------------
---------

## Command summary

Expand All @@ -569,9 +573,7 @@ _{TO DO}_

--------------------------------------------------------------------------------------------------------------------

Appendix

## UG workload distribution
## Appendix: UG workload distribution

| Full Name of Team Member | Agreed allocated sections, duties, roles | Changes if any, record date and reasons for changes | Actual contribution to the UG |
|--------------------------|--------------------------------------------------------------------------|-----------------------------------------------------|--------------------------------------------------------------------------|
Expand Down

0 comments on commit 95aa75b

Please sign in to comment.