Skip to content

Commit

Permalink
Add tips and update formatting for user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
zaidansani committed Nov 6, 2024
1 parent 77348d9 commit b70a440
Showing 1 changed file with 142 additions and 38 deletions.
180 changes: 142 additions & 38 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<br>

![](images/doctrack.png)
# User Guide
# **User Guide**

<box type="info" light theme="primary">
<b>DocTrack</b> is a desktop application for <b>general practitioners (GPs)</b> to quickly access patient contact
Expand All @@ -26,30 +26,74 @@ in this user guide.

---

## Introduction
## **Introduction**

- [Quick start](#quick-start):
- Quickly get started with DocTrack.
<box type="tip" light>

<a href="#quick-start" class="badge bg-success">Quick Start</a>

Quickly get started with DocTrack!

Click on this section for a quick set-up guide, with examples of commands that you can use, out of the box.

</box>

<box type="info" light>

<a href="#interacting-with-doctrack" class="badge bg-info">Interacting with DocTrack</a>

Learn how you can interact with DocTrack!

DocTrack functions through a set of commands. Click on this section to learn more.

</box>

<box type="definition" light>

<a href="#command-overview" class="badge bg-primary">Command Overview</a>

Click on this section to know more about the commands you can use in DocTrack.
For more specifics, click on the subsections below.

<box light>

<a href="#person-commands" class="badge bg-dark">Person commands</a>
Click on this section for a rough summary of all the commands related to persons.

</box>

<box light>

<a href="#appointment-commands" class="badge bg-dark">Appointment commands</a>
Click on this section for a rough summary of all the commands related to appointments.

- [Interacting with DocTrack](#interacting-with-doctrack):
- Learn how you can interact with DocTrack.
</box>

<box light>

<a href="#general-commands" class="badge bg-dark">General commands</a>
Click on this section for a rough summary of all the general commands.

- [Command Overview](#command-overview):
- Navigate here for information on how the commands work.
- [Summary of Commands](#summary-of-commands):
- for a general summary of all commands.
- [Person Commands](#person-commands):
- for more information on person commands.
- [Appointment Commands](#appointment-commands):
- for more information on appointment commands.
- [General Commands](#general-commands):
- for more information on general commands.
</box>

- [FAQ](#faq):
- Find answers to common questions you might have.
</box>

<box type="warning" light>

<a href="#faq" class="badge bg-warning">FAQs</a>

Have questions? Read here to see answer to commonly asked questions.

</box>

<box type="warning" light>

<a href="#known-issues" class="badge bg-warning">Known issues</a>

Having a problem? Read here to see some common issues that may arise while you are using DocTrack.

</box>

- [Known issues](#known-issues):
- Discover common issues that may arise while you are using DocTrack.

<!-- * Table of Contents -->
<page-nav-print></page-nav-print>
Expand All @@ -60,7 +104,7 @@ in this user guide.

<br>

## Quick start
## **Quick start**

1. Ensure you have Java `17` or above installed in your computer.
- To install `Java 17`, download Java. Refer to the [guide for installing Java](https://docs.oracle.com/en/java/javase/17/install/overview-jdk-installation.html).
Expand Down Expand Up @@ -113,17 +157,32 @@ in this user guide.

<br>

7. You can refer to the [Command Overview](#command-overview) below for details of each command.
<box type="tip" light>

**Tip:**

This would be a good time to run the `clear person` command, to start afresh without sample data.

</box>

<br>

7. You can refer to the <a href="#command-overview" class="badge bg-primary">Command Overview</a> below for details of each command.
* You can also go to the specific subsections:
<a href="#person-commands" class="badge bg-dark">Person commands</a>
<a href="#appointment-commands" class="badge bg-dark">Appointment commands</a>
<a href="#general-commands" class="badge bg-dark">General commands</a>

<br>

---

<br>

## Interacting with DocTrack
## **Interacting with DocTrack**

All interactions with the DocTrack platform are done through a series of **commands** entered by you.
All interactions with the DocTrack platform are done through a series of **commands**
(explained in <a href="#command-overview" class="badge bg-primary">Command Overview</a>) entered by you.
- These commands allow you to perform various **tasks**, such as adding, editing, listing, deleting, finding,
and clearing persons/appointments.
- The commands are designed to be flexible and user-friendly.
Expand Down Expand Up @@ -160,7 +219,7 @@ _**Example:** If the command specifies `help 123`, then it will be interpreted a

</box>

<box type="warning" light seamless style="border: 1px solid red">
<box type="warning" light style="border: 1px solid red">

**Caution:**

Expand All @@ -176,17 +235,60 @@ If you are using a PDF version of this document, be careful when copying and pas

<br>

## Command Overview
## **Command Overview**

The following sections describe the various commands you can use in the DocTrack application.

---

<a href="#person-commands" class="badge bg-dark">Person commands</a>
Click this section to know more about the commands, or click on the individual commands below for information
specific to those commands.

| Action | Format | Examples |
|-------------------------------------------------------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|
| **[Add person](#adding-a-person-add-person)** | `add person n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS st/STATUS [t/TAG]…​` | `add person n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01 st/recovering t/friend` |
| **[List all persons](#listing-all-persons-list-person)** | `list person` <br/> | `list person` |
| **[Edit person](#editing-a-person-edit-person)** | `edit person INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [st/STATUS] [t/TAG]…​` | `edit person 2 n/James Lee e/[email protected]` |
| **[Find person](#finding-persons-by-name-find-person)** | `find person KEYWORD [MORE_KEYWORDS]` | `find person n/James Jake` |
| **[Delete person](#deleting-a-person-delete-person)** | `delete person INDEX` | `delete person 3` |
| **[Clear all persons](#clearing-all-persons-clear-person)** | `clear person` | `clear person` |

<br>

---

<a href="#appointment-commands" class="badge bg-dark">Appointment commands</a>
Click this section to know more about the commands, or click on the individual commands below for information
specific to those commands.

| Action | Format | Examples |
|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| **[Add appointment](#adding-an-appointment-add-appt)** | `add appt i/PERSON_ID d/DATE_TIME ty/APPOINTMENT_TYPE [s/SICKNESS] [m/MEDICINE]` <br/> <br/> | `add appt i/1 d/2024-12-01 09:30 ty/Consulation s/Diabetes m/Insulin` |
| **[List all appointments](#listing-all-appointments-list-appt)** | `list appt` | `list appt` |
| **[Edit appointment](#editing-an-appointment-edit-appt)** | `edit appt INDEX [i/PERSON_ID] [d/DATE_TIME] [ty/APPOINTMENT_TYPE] [s/SICKNESS] [m/MEDICINE]` | `edit appt 3 d/2024-12-05 13:00 m/Panadol` |
| **[Find appointment](#finding-appointments-by-name-and-date-find-appt)** | `find appt KEYWORD [MORE_KEYWORDS]` | `find appt d/2024-12-05` |
| **[Delete appointment](#deleting-an-appointment-delete-appt)** | `delete appt INDEX` | `delete appt 2` |
| **[Clear all appointments](#clearing-all-appointments-clear-appt)** | `clear appt` <br/> | `clear appt` |

<br>

---

The following sections describe the various commands you can use in the DocTrack application:
<a href="#general-commands" class="badge bg-dark">General commands</a>
Click this section to know more about the commands, or click on the individual commands below for information
specific to those commands.

- [Person Commands](#person-commands)
- [Appointment Commands](#appointment-commands)
- [General Commands](#general-commands)
| Action | Format | Examples |
|---------------------------------------|--------|----------|
| **[Help](#viewing-help-help)** | `help` | `help` |
| **[Exit](#exiting-the-program-exit)** | `exit` | `exit` |

<br>

### Person Commands
---

### **Person Commands**

A **person** is a patient with several fields. The fields and their corresponding prefixes are as follows:

Expand Down Expand Up @@ -306,6 +408,7 @@ You can delete a specified person from the patient book.
<box type="warning" light>

**Warning:** This action is irreversible. Ensure you have selected the correct person before deleting.
Note that deleting a person will also delete all related appointments.

</box>

Expand All @@ -331,6 +434,7 @@ You can delete all person entries from the patient book.
<box type="warning" light>

**Warning:** This action is irreversible. Ensure you have a backup of the patient data before clearing.
Note that this will also clear the appointment data.

</box>

Expand All @@ -341,7 +445,7 @@ You can delete all person entries from the patient book.

<br>

### Appointment Commands
### **Appointment Commands**

An **appointment** is defined by several fields. The fields and their corresponding prefixes are as follows:

Expand All @@ -365,7 +469,6 @@ You can manage the appointments through different commands, which can be seen in
| **[Find appointment](#finding-appointments-by-name-and-date-find-appt)** | `find appt KEYWORD [MORE_KEYWORDS]` | `find appt d/2024-12-05` |
| **[Delete appointment](#deleting-an-appointment-delete-appt)** | `delete appt INDEX` | `delete appt 2` |
| **[Clear all appointments](#clearing-all-appointments-clear-appt)** | `clear appt` <br/> | `clear appt` |
---

<br>

Expand Down Expand Up @@ -492,7 +595,7 @@ This action is irreversible. Ensure you have a backup of the appointment data be

<br>

### General Commands
### **General Commands**

**General commands** can help you with miscellaneous tasks related to patient and appointment management.

Expand Down Expand Up @@ -524,13 +627,14 @@ You will be able to exit the DocTrack application.
##### 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.
- For more information on how the data is stored, you can refer to the [FAQ](#faq) section.
- For more information on how the data is stored, you can refer to <a href="#faq" class="badge bg-warning">FAQs</a>.

<br>

##### Editing the data file

For advanced users, feel free to update patient and appointment data directly by editing the [data files](#faq) in the `data` folder.
For advanced users, feel free to update patient and appointment data directly by editing the [data files](#faq) in the
`data` folder. Learn more here: <a href="#faq" class="badge bg-warning">FAQs</a>.

<box type="warning" light>

Expand All @@ -548,7 +652,7 @@ For advanced users, feel free to update patient and appointment data directly by

<br>

## FAQ
## **FAQ**

**Q**: How is my data stored?<br>
**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.
Expand Down Expand Up @@ -587,7 +691,7 @@ folder, you can copy these files to another location as a backup.

<br>

## Known issues
## **Known issues**

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.

Expand Down

0 comments on commit b70a440

Please sign in to comment.