You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/UserGuide.md
+16-13Lines changed: 16 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -12,16 +12,16 @@ Those days are over!
12
12
Introducing **ImmuniMate**, our innovative platform designed to revolutionize the way healthcare professionals and staff manage patient information.
13
13
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!
14
14
15
-
## Who This App is For
15
+
###Who This App is For
16
16
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:
18
18
19
19
* have basic experience in using computers
20
20
* have a computer with sufficient space (~100 MB)
21
21
* are comfortable typing on a regular basis
22
22
* have no serious colour vision deficiencies (can differentiate red, yellow and green)
23
23
24
-
## Purpose of This Guide
24
+
###Purpose of This Guide
25
25
26
26
If you ticked all the points above, great!
27
27
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!
50
50
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.
51
51
The table of contents just before this section breaks down the guide into its constituent sections:
52
52
53
-
1. How to Use This Guide (this section)
53
+
1.**How to Use This Guide** (this section)
54
54
* descriptions on different sections of user guide
55
55
* glossary on technical terms
56
-
2. Product Information
56
+
2.**Product Information**
57
57
* detailed description of product
58
58
* summary of command and fields
59
-
3. Quick start
59
+
3.**Quick Start**
60
60
* system requirements
61
61
* how to download and get started on the app
62
-
4. Features
62
+
4.**Features**
63
63
* explains each feature with examples
64
64
* common usage mistakes
65
-
5. Frequently Asked Questions
66
-
6. Known issues
65
+
5.**Frequently Asked Questions**
66
+
6.**Known issues**
67
67
* descriptions on issues with ImmuniMate that have been spotted, but not fixed
68
68
69
69
Navigating a complex document can be time-consuming, and we understand.
@@ -118,10 +118,13 @@ Examples:
118
118
* (consequence)
119
119
* ...
120
120
121
-
Common mistakes:
121
+
<divmarkdown="block"class="alert alert-danger">
122
+
123
+
**:x: Common Mistakes**<br>
122
124
*`wrong use case 1` (reason)
123
125
*`wrong use case 2` (reason)
124
126
* ...
127
+
</div>
125
128
126
129
<br>
127
130
@@ -226,15 +229,15 @@ Find retyping commands a hassle? Use your 'Up' and 'Down' arrow keys to access y
226
229
227
230
**:bulb: Tip:**<br>
228
231
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).
230
233
Take great care in downloading the one which suits your operating system (Linux, Windows, MacOS etc).
231
234
</div>
232
235
233
236

234
237
235
238
2. Download the latest `immuniMate.jar` from [our website](https://github.com/AY2324S2-CS2103T-T08-1/tp/releases).
0 commit comments