Skip to content

Commit

Permalink
Merge pull request #305 from afroneth/UG-contributions
Browse files Browse the repository at this point in the history
Add UG contribution
  • Loading branch information
gsmoon97 authored Nov 12, 2020
2 parents 819e9ee + 043a805 commit 8803de5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ title: CliniCal User Guide

## 1. Introduction

(Contributed by Kenneth)

CliniCal (Clinic Calendar) is a **desktop app that allows doctors to manage patient records and schedule upcoming appointments**. With CliniCal, you can enhance your daily workflow through the effective scheduling of medical appointments. You can also have access to a digital database that safely stores all your patient records.

Furthermore, CliniCal is optimized for use via a Command Line Interface (CLI) and even retains the benefits of a Graphical User Interface (GUI). If you can type fast, CliniCal can get your work done faster than traditional GUI apps.
Expand Down Expand Up @@ -604,6 +606,8 @@ You want to display the profile of the 1st patient on the list.

### 5.3 Patient Visitation Commands

(Contributed by Kenneth)

Visitation commands help you make changes to the visitation logs specific to a patient.

These visitation logs store the following as a short summary of a patient's visit:
Expand Down Expand Up @@ -896,6 +900,8 @@ Retrieve and reuse past commands using the <kbd>↑</kbd> arrow and <kbd>↓</kb

### 5.6 Saving the data

(Contributed by Kenneth)

CliniCal data is saved in your hard disk automatically after any command that changes the data. There is no need to save manually.

--------------------------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -927,7 +933,7 @@ CliniCal data is saved in your hard disk automatically after any command that ch
**A**: Yes! Our data is stored in the file `clinical.json` in the `data` folder you run CliniCal in. You may modify this file to modify the database directly. Keep in mind that if the data is stored in a format that doesn't match the formatting described in [Section 5.2.1](#521-adding-a-patient-add), the application will start with an empty set of data.

**Q**: I've spotted a bug in your application. How can I report this?<br>
**A**: We would love to hear from you. You can either email us at `seer [at] comp.nus.edu.sg` or make a GitHub issue at this [link](https://github.com/AY2021S1-CS2103T-W11-4/tp/issues) with the relevant details.
**A**: We would love to hear from you. You can either email us at `ktaekwon000 [at] gmail dot com` or make a GitHub issue at this [link](https://github.com/AY2021S1-CS2103T-W11-4/tp/issues) with the relevant details.

**Q**: Is there a way to export the calendar data into another application, say Google Calendar?<br>
**A**: We are currently working on this feature and it is planned for `v2.0`, scheduled to be released in January 2021.
Expand All @@ -936,6 +942,8 @@ CliniCal data is saved in your hard disk automatically after any command that ch

## 7. Command summary

(Contributed by Kenneth)

Action | Format, Examples
--------|------------------
**Add** | `add n/NAME p/PHONE_NUMBER ic/NRIC [a/ADDRESS] [e/EMAIL] [s/SEX] [b/BLOOD_TYPE] [ct/COLOR_TAG] [g/ALLERGY]…​` <br> e.g. `add n/James Ho p/22224444 ic/S2686887R e/[email protected] a/123, Clementi Rd, 1234665 s/M b/B+ g/sulfa g/aspirin`
Expand Down

0 comments on commit 8803de5

Please sign in to comment.