Skip to content

Commit 101f3d3

Browse files
alex-setyawanalex-setyawan
committed
More enhancements
1 parent e527c6b commit 101f3d3

File tree

1 file changed

+30
-21
lines changed

1 file changed

+30
-21
lines changed

‎docs/UserGuide.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ The table of contents just before this section breaks down the guide into its co
6666
6. Known issues
6767
* descriptions on issues with ImmuniMate that have been spotted, but not fixed
6868

69-
<br>
70-
7169
Navigating a complex document can be time-consuming, and we understand.
7270
That's why we've placed hyperlinks throughout this article (like [this one](#command-summary), to the command summary), so that any information you need is truly at your fingertips.
7371

72+
### Information Boxes
73+
7474
Before engaging with ImmuniMate, there are some things that are so important that they have to catch your eye.
7575
That's why we made these nice blue note boxes to capture your attention, to plug gaps in your understanding before proceeding with ImmuniMate.
7676
<div markdown="block" class="alert alert-info">
@@ -79,13 +79,24 @@ That's why we made these nice blue note boxes to capture your attention, to plug
7979
This is what a note box looks like.
8080
</div>
8181

82-
Sometimes, certain instructions might sound very new or contain too many technical terms, which is why we also positioned a few tip snippets below them, so that you'll never have to fret about the intricacies of ImmuniMate.
82+
Sometimes, certain instructions might sound very new or contain too many technical terms, which is why we also positioned a few tip snippets below them in green boxes, so that you'll never have to fret about the intricacies of ImmuniMate.
8383
<div markdown="block" class="alert alert-success">
8484

8585
**:bulb: Tip:**<br>
86-
This is what a tip snippet looks like
86+
This is what a tip snippet looks like.
87+
</div>
88+
89+
Mistakes are inevitable, even in the healthcare industry.
90+
But we should always strive to minimise them, and we're helping you do just that by informing you of common mistakes that have happened countless times.
91+
You can view them in red boxes such as this one.
92+
93+
<div markdown="block" class="alert alert-danger">
94+
95+
**:x: Common Mistakes**<br>
96+
This is what a common mistake box looks like.
8797
</div>
8898

99+
<br>
89100
<br>
90101

91102
ImmuniMate comes with an abundant set of features, each of which we have taken great care to explain in great detail.
@@ -149,21 +160,21 @@ The list of commands and their formats are specified below:
149160

150161
### Command summary
151162

152-
| Action | Format, Examples |
153-
|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
154-
| **[Create](#creating-a-patient-profile-create)** | `create <ic/NRIC> <n/Patient_Name> <hp/Phone_Number> a/<Address> <dob/Date_of_birth> <s/Sex> <st/Status> [e/Email] [c/Country_of_Nationality] [doa/Date_of_Admission] [bt/Blood type] [al/Allergies] [con/Condition] [sym/Symptom] [d/diagnosis]` <br> e.g., `create ic/S1234567A n/John Doe hp/98765432 a/311, Clementi Ave 2, #02-25 dob/1990-01-01 s/M st/PENDING` |
155-
| **[Read](#read-specific-patients-read)** | `read <NRIC>` <br> e.g., `read S1234567A` |
156-
| **[Update](#updating-a-patient-profile-update)** | `update <NRIC> <Field>/<Content>` <br> e.g., `update S1234567A hp/91234567 e/jd123@example.com` |
157-
| **[Find](#finding-patients-by-name-find)** | `find n/<Part_of_name> <Part_of_name> <Part_of_name>` <br> e.g., `find n/Alex Bryan Charlie` <br> `find a/<Part_of_Address>, <Part_of_Address>, <Part_of_Address>, ...` <br> e.g., `find a/Serangoon, Geylang` <br> `find con/<Part_of_Condition>, <Part_of_Condition>, <Part_of_Condition>, ...` <br> e.g., `find con/Covid, Ebola` |
158-
| **[Delete Patient](#deleting-a-patient-delete)** | `delete <NRIC>`<br> e.g., `delete S1234567A` |
159-
| **[Delete Information](#deleting-information-of-a-patient-deleteinfo)** | `deleteinfo <NRIC> <Field>` <br> e.g., `deleteinfo S1234567A e/` |
160-
| **[Add Visit](#add-patient-visit-to-history-addvisit)** | `addvisit ic/<NRIC> dov/<Date_of_Visit> sym/<Symptoms> d/<Diagnosis> st/<Status>` <br> e.g., `addvisit ic/S1234567A dov/2024-01-01 sym/Cough d/Covid st/UNWELL` |
161-
| **[Check](#check-patient-history-check)** | `check <NRIC>` <br> e.g., `check S1234567A` |
162-
| **[Find Cluster](#cluster-finding-cluster)** | `cluster <cluster size> a/<Part_of_Address> d/<Diagnosis>` <br> e.g. `cluster 3 a/Serangoon d/dengue` |
163-
| **[Clear](#clearing-all-entries-clear)** | `clear` |
164-
| **[List](#listing-all-patients-list)** | `list` |
165-
| **[Help](#viewing-help-help)** | `help` |
166-
| **[Exit](#exiting-the-program-exit)** | `exit` |
163+
| Action | Format | Examples |
164+
|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
165+
| **[Create](#creating-a-patient-profile-create)** | `create <ic/NRIC> <n/Patient_Name> <hp/Phone_Number> a/<Address> <dob/Date_of_birth> <s/Sex> <st/Status> [e/Email] [c/Country_of_Nationality] [doa/Date_of_Admission] [bt/Blood type] [al/Allergies] [con/Condition] [sym/Symptom] [d/diagnosis]` | `create ic/S1234567A n/John Doe hp/98765432 a/311, Clementi Ave 2, #02-25 dob/1990-01-01 s/M st/PENDING` |
166+
| **[Read](#read-specific-patients-read)** | `read <NRIC>` | `read S1234567A` |
167+
| **[Update](#updating-a-patient-profile-update)** | `update <NRIC> <Field>/<Content>` | `update S1234567A hp/91234567 e/jd123@example.com` |
168+
| **[Find](#finding-patients-by-name-find)** | `find n/<Part_of_name> <Part_of_name> <Part_of_name>`<br> `find a/<Part_of_Address>, <Part_of_Address>, <Part_of_Address>, ...` <br> `find con/<Part_of_Condition>, <Part_of_Condition>, <Part_of_Condition>, ...` | `find n/Alex Bryan Charlie` <br> `find a/Serangoon, Geylang` <br> `find con/Covid, Ebola` |
169+
| **[Delete Patient](#deleting-a-patient-delete)** | `delete <NRIC>` | `delete S1234567A` |
170+
| **[Delete Information](#deleting-information-of-a-patient-deleteinfo)** | `deleteinfo <NRIC> <Field>` | `deleteinfo S1234567A e/` |
171+
| **[Add Visit](#add-patient-visit-to-history-addvisit)** | `addvisit ic/<NRIC> dov/<Date_of_Visit> sym/<Symptoms> d/<Diagnosis> st/<Status>` | `addvisit ic/S1234567A dov/2024-01-01 sym/Cough d/Covid st/UNWELL` |
172+
| **[Check](#check-patient-history-check)** | `check <NRIC>` | `check S1234567A` |
173+
| **[Find Cluster](#cluster-finding-cluster)** | `cluster <cluster size> a/<Part_of_Address> d/<Diagnosis>` | `cluster 3 a/Serangoon d/dengue` |
174+
| **[Clear](#clearing-all-entries-clear)** | `clear` | - |
175+
| **[List](#listing-all-patients-list)** | `list` | - |
176+
| **[Help](#viewing-help-help)** | `help` | - |
177+
| **[Exit](#exiting-the-program-exit)** | `exit` | - |
167178

168179
<br>
169180
<br>
@@ -310,8 +321,6 @@ Format: `list`
310321

311322
**Creates a patient profile in ImmuniMate.**
312323

313-
pro
314-
315324
Format: `create ic/<NRIC> n/<Patient_Name> hp/<Phone_Number> a/<Address> dob/<Date_of_birth> s/<Sex> st/<Status> [e/Email] [c/Country_of_Nationality] [doa/Date_of_Admission] [bt/Blood type] [al/Allergies] [con/Condition] [sym/Symptom] [d/diagnosis]`
316325

317326
* All mandatory fields must be provided. Refer to the [Field Summary](#field-summary) for a list of mandatory and optional fields, and their formats.

0 commit comments

Comments
 (0)