diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 6d23083b68e..af3503d5414 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -6,7 +6,12 @@
-
+
+
# **User Guide**
@@ -14,8 +19,8 @@
details, appointments, and treatment records.
-With DocTrack, you can take the first step towards digitalisation of your practice!
-DocTrack aims to simplify your patient and appointment tracking process, by allowing you to
+With **DocTrack**, you can take the first step towards digitalisation of your practice!
+**DocTrack** aims to simplify your patient and appointment tracking process, by allowing you to
- easily add and update patient and appointment records
- delete records for regulation purposes
- search for records based on important criteria such as dates and names
@@ -24,8 +29,13 @@ with an intuitive and user-friendly interface!
To get started, you can read the introduction below, which shows all the different sections
in this user guide.
+
+
+
---
+
+
## **Introduction**
@@ -94,14 +104,12 @@ Having a problem? Read here to see some common issues that may arise while you a
-
-
-
-
---
+
+
## **Quick start**
@@ -130,7 +138,7 @@ Having a problem? Read here to see some common issues that may arise while you a
cd HOME_FOLDER
java -jar DocTrack.jar
```
- For example, if you copied `DocTrack.jar` into the folder `C:/Users/user/Documents`,
+ **_Example:_** if you copied `DocTrack.jar` into the folder `C:/Users/user/Documents`,
run the commands:
```
cd C:/Users/user/Documents
@@ -175,6 +183,8 @@ This would be a good time to run the `clear person` command, to start afresh wit
+
+
---
@@ -229,6 +239,8 @@ If you are using a PDF version of this document, be careful when copying and pas
+
+
---
@@ -286,6 +298,8 @@ specific to those commands.
+
+
---
### **Person Commands**
@@ -338,6 +352,16 @@ _**Example:** `t/friend t/likes coding` has 2 tags and it is valid._
- `add person n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 st/recovered t/criminal` adds a person named `Betsy Crowe` with email `betsycrowe@example.com`, address `Newgate
Prison`, phone number `1234567`, status `recovered`, and the tags `friend` and `criminal`.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Listing all persons : `list person`
@@ -346,6 +370,16 @@ You can view a list of all persons in the patient book.
**Format**: `list person` shows the list of all patients on the screen.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Editing a person : `edit person`
@@ -373,6 +407,16 @@ Edits an existing patient in DocTrack.
**Tip:** When trying to add tags while keeping existing tags, remember to type in all the pre-existing tags with your new tags
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Finding persons by name: `find person`
@@ -395,6 +439,16 @@ You can find person(s) whose **names** contain any of the given keywords.
- `find person n/alex david` returns `Alex Yeoh`, `David Li`
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Deleting a person : `delete person`
@@ -423,6 +477,16 @@ Note that deleting a person will also delete all related appointments.
- `list` followed by `delete person 2` deletes the second person in the list.
- `find Betsy` followed by `delete person 1` deletes the first person in the results of the `find` command.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Clearing all persons : `clear person`
@@ -438,9 +502,20 @@ Note that this will also clear the appointment data.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
---
@@ -498,6 +573,16 @@ _**Example:** You will see `2024-12-10 12:30` displayed as `December 10, 2024, 1
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Listing all appointments : `list appt`
@@ -506,6 +591,16 @@ You can view a list of all appointments in the appointment book.
**Format**: `list appt`
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
##### Editing an appointment : `edit appt`
@@ -525,6 +620,18 @@ You can an existing appointment in appointment book.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
+
##### Finding appointments by name and date: `find appt`
You can find appointments whose person names and / or dates contain any of the given keywords.
@@ -539,8 +646,13 @@ You can find appointments whose person names and / or dates contain any of the g
- `find appt n/John` returns appointments with patients named `John`.
- `find appt d/2024-12-05` returns appointments on `2024-12-05`.
- `find appt n/John d/2024-12-05` returns appointments with patients named `John`, and is on `2024-12-05`.
+
+
+
+
+
**Tip:** Use the `find appt` command to filter out appointments for a certain day or patient
@@ -549,6 +661,18 @@ You can find appointments whose person names and / or dates contain any of the g
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
+
##### Deleting an appointment : `delete appt`
You can delete a specified appointment from appointment book.
@@ -569,6 +693,9 @@ You can delete a specified appointment from appointment book.
- `find appt d/2024-12-05` followed by `delete appt 1` deletes the first appointment in the results of the
`find` command.
+
+
+
**Tip:** Use the `list appt` to check the index of the appointment before deleting one.
@@ -576,6 +703,18 @@ You can delete a specified appointment from appointment book.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
+
##### Clearing all appointments : `clear appt`
You can delete all appointment entries from the appointment book.
@@ -591,6 +730,20 @@ This action is irreversible. Ensure you have a backup of the appointment data be
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
+
+
+
---
@@ -616,6 +769,18 @@ You will be able to view a help window that directs you to this user guide.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
+
##### Exiting the program : `exit`
You will be able to exit the DocTrack application.
@@ -624,6 +789,18 @@ You will be able to exit the DocTrack application.
+
+
+**Navigate back to the subsections here:**
+Command overview
+Person commands
+Appointment commands
+General commands
+
+
+
+
+
##### Saving the data
The data of the patients and appointments are saved in the hard disk automatically after you run any command that changes the data. You do not need to save them manually.
@@ -648,6 +825,8 @@ For advanced users, feel free to update patient and appointment data directly by
+
+
---
@@ -655,14 +834,67 @@ For advanced users, feel free to update patient and appointment data directly by
## **FAQ**
**Q**: How is my data stored?
-**A**: Your data is stored in [.json](https://www.json.org/json-en.html) files, located in the `data` folder. The details of patients are stored in the `addressbook.json` file, while the appointments are stored in the `appointmentbook.json` file.
-Examples:
-
-
-
+**A**: Your data is stored in [.json](https://www.json.org/json-en.html) files, located in the `data` folder. The details of patients are stored in the `addressbook.json` file,
+while the appointments are stored in the `appointmentbook.json` file.
-
+Examples:
+An example of how the persons are stored:
+
+```json
+{
+ "persons": [
+ {
+ "personId": 0,
+ "name": "Alex Yeoh",
+ "phone": "87438807",
+ "email": "alexyeoh@example.com",
+ "address": "Blk 30 Geylang Street 29, #06-40",
+ "status": "Recovering",
+ "tags": [
+ "friends"
+ ]
+ },
+ {
+ "personId": 1,
+ "name": "Bernice Yu",
+ "phone": "99272758",
+ "email": "berniceyu@example.com",
+ "address": "Blk 30 Lorong 3 Serangoon Gardens, #07-18",
+ "status": "Stable",
+ "tags": [
+ "colleagues",
+ "friends"
+ ]
+ }
+ ]
+}
+```
+
+An example of how the appointments are stored:
+
+```json
+{
+ "appointments": [
+ {
+ "appointmentId": 0,
+ "appointmentType": "Consultation",
+ "appointmentDateTime": "2024-10-20T09:30",
+ "personId": 0,
+ "sickness": "Flu",
+ "medicine": "Antiviral"
+ },
+ {
+ "appointmentId": 1,
+ "appointmentType": "Follow-up",
+ "appointmentDateTime": "2024-10-22T14:00",
+ "personId": 1,
+ "sickness": "Diabetes",
+ "medicine": "Insulin"
+ }
+ ]
+}
+```
**Q**: How do I transfer my data (in the `addressbook.json` and `appointmentbook.json` files) to another
@@ -700,3 +932,7 @@ folder, you can copy these files to another location as a backup.
2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.
+
+3. On **MacOS systems**, the bold fonts may appear slightly clipped.
+
+