Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UG contributions #310

Merged
merged 1 commit into from
Nov 13, 2020
Merged

Update UG contributions #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,16 @@ Interested to know more? Take a look at our [**Getting started**](#3-getting-sta

## 2. About this document

(Contributed by Eugene)

Welcome to the CliniCal User Guide!

If you are new to CliniCal, this user guide will get you up and running in no time! It equips you with the basic knowledge you need to use CliniCal properly.

### 2.1 Formatting

(Contributed by Eugene)

The CliniCal User Guide contains different formatting used throughout the document which is used to convey different meanings.
This table below illustrates what each formatting means.

Expand Down Expand Up @@ -113,6 +117,8 @@ You can follow the steps below to get CliniCal up and running:

## 4. User Interface

(Contributed by Eugene)

CliniCal contains a Graphical User Interface (GUI) which serves to allow you to easily view upcoming appointments and also patient records.

<p align="center">
Expand All @@ -133,6 +139,8 @@ If you wish to start afresh, enter the `clear` command to clear all entries from

### 4.1 Overview Tab

(Contributed by Eugene)

<p align="center">
<img src="images/overviewLayout.png"/>
<br>
Expand Down Expand Up @@ -162,6 +170,8 @@ This would be the main screen of CliniCal, where the appointment list would be o

### 4.2 Patients Tab

(Contributed by Eugene)

<p align="center">
<img src="images/patientLayout.png"/>
<br>
Expand Down Expand Up @@ -189,6 +199,8 @@ This tab shows you the patient list and the details of each patient, together wi

### 4.3 Profile Window

(Contributed by Eugene)

<p align="center">
<img src="images/profileLayout.png"/>
<br>
Expand Down Expand Up @@ -286,6 +298,8 @@ Format: `clearhistory`

#### 5.1.4 Undoing the previous command: `undo`

(Contributed by Eugene)

Revert your previous command which modified the patient list.

Format: `undo`
Expand All @@ -312,6 +326,8 @@ You want to restore Alex Yeoh's patient details right after accidentally using t

#### 5.1.5 Redoing a command: `redo`

(Contributed by Eugene)

Redo the most recent command that you have undone.

Format: `redo`
Expand Down Expand Up @@ -520,6 +536,8 @@ You want to delete the 6th patient.

#### 5.2.5 Deleting all patients: `clear`

(Contributed by Eugene)

Clear all patient entries from the patient list.

Format: `clear`
Expand Down Expand Up @@ -556,6 +574,8 @@ You want to delete all the patients.

#### 5.2.6 Finding patients: `find`

(Contributed by Eugene)

Find patients whose names or NRIC contain any of the given keywords.

Format: `find KEYWORDS`
Expand Down Expand Up @@ -589,6 +609,8 @@ You want to find all the patients with `yu` in their names.

#### 5.2.7 Listing all patients: `list`

(Contributed by Eugene)

View a list of all your patients in the patient list.

Format: `list`
Expand Down