Skip to content

Commit 579359b

Browse files
committed
Last last UG enhancement
1 parent c5219da commit 579359b

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

docs/UserGuide.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ Those days are over!
1212
Introducing **ImmuniMate**, our innovative platform designed to revolutionize the way healthcare professionals and staff manage patient information.
1313
It's your secure, centralized hub where you can access all your patients' medical and personal details – allergies, visit history, medical conditions, you name it – just a few clicks away!
1414

15-
## Who This App is For
15+
### Who This App is For
1616

17-
ImmuniMate is designed for healthcare professionals (doctors, nurses etc.) and healthcare staff (clinic receptionist etc.) longing to leverage the efficiencies of the 21st century, who:
17+
ImmuniMate is designed for **healthcare professionals** (doctors, nurses etc.) and **healthcare staff** (clinic receptionist etc.) longing to leverage the efficiencies of the 21st century, who:
1818

1919
* have basic experience in using computers
2020
* have a computer with sufficient space (~100 MB)
2121
* are comfortable typing on a regular basis
2222
* have no serious colour vision deficiencies (can differentiate red, yellow and green)
2323

24-
## Purpose of This Guide
24+
### Purpose of This Guide
2525

2626
If you ticked all the points above, great!
2727
This user guide is here as your helping hand, imparting knowledge to unlock the full potential of ImmuniMate.
@@ -50,20 +50,20 @@ Let's dive in and explore how ImmuniMate can transform your practice!
5050
ImmuniMate's user guide is optimised for ease of navigation, so that you can spend less time on the app, and more time on your patients.
5151
The table of contents just before this section breaks down the guide into its constituent sections:
5252

53-
1. How to Use This Guide (this section)
53+
1. **How to Use This Guide** (this section)
5454
* descriptions on different sections of user guide
5555
* glossary on technical terms
56-
2. Product Information
56+
2. **Product Information**
5757
* detailed description of product
5858
* summary of command and fields
59-
3. Quick start
59+
3. **Quick Start**
6060
* system requirements
6161
* how to download and get started on the app
62-
4. Features
62+
4. **Features**
6363
* explains each feature with examples
6464
* common usage mistakes
65-
5. Frequently Asked Questions
66-
6. Known issues
65+
5. **Frequently Asked Questions**
66+
6. **Known issues**
6767
* descriptions on issues with ImmuniMate that have been spotted, but not fixed
6868

6969
Navigating a complex document can be time-consuming, and we understand.
@@ -118,10 +118,13 @@ Examples:
118118
* (consequence)
119119
* ...
120120

121-
Common mistakes:
121+
<div markdown="block" class="alert alert-danger">
122+
123+
**:x: Common Mistakes**<br>
122124
* `wrong use case 1` (reason)
123125
* `wrong use case 2` (reason)
124126
* ...
127+
</div>
125128

126129
<br>
127130

@@ -226,15 +229,15 @@ Find retyping commands a hassle? Use your 'Up' and 'Down' arrow keys to access y
226229

227230
**:bulb: Tip:**<br>
228231
Don't worry if you don't have Java 11 installed yet!
229-
The Java Development Kit (kind of like an installer) can be downloaded from [here](https://www.oracle.com/sg/java/technologies/downloads/#java11).
232+
The Java Development Kit (kind of like an installer) can be downloaded from [here](https://www.oracle.com/sg/java/technologies/downloads/#java11) (screenshot below).
230233
Take great care in downloading the one which suits your operating system (Linux, Windows, MacOS etc).
231234
</div>
232235

233236
![Java website](images/JavaWebsite.png)
234237

235238
2. Download the latest `immuniMate.jar` from [our website](https://github.com/AY2324S2-CS2103T-T08-1/tp/releases).
236239

237-
<img src="images/GithubReleasePage.png" alt="help message" width="500"/>
240+
<img src="images/GithubReleasePage.png" alt="help message" width="700"/>
238241

239242
3. Copy the file to the folder you want to use as the _home folder_ for your ImmuniMate.
240243

@@ -251,7 +254,7 @@ Find retyping commands a hassle? Use your 'Up' and 'Down' arrow keys to access y
251254

252255
![Ui](images/GUI.png)
253256

254-
6. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
257+
6. Type the command in the command box and press "Enter" to execute it. e.g. typing **`help`** and pressing "Enter" will open the help window.<br>
255258
Some example commands you can try:
256259

257260
* `list` : Lists all contacts.

0 commit comments

Comments
 (0)