Skip to content

Commit

Permalink
Merge pull request #58 from pjanthony2001/update-user-guide
Browse files Browse the repository at this point in the history 
Update User Guide
  • Loading branch information
@tejas-1405
tejas-1405 authored Mar 24, 2024
2 parents a296a78 + df1f4c3 commit 2ee009f
Showing 1 changed file with 81 additions and 35 deletions.
116 changes: 81 additions & 35 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@
# ConnectCare User Guide

<box type="info" seamless>
This page is for ConnectCare users. If you're a developer, see also the [Developer guide](https://ay2324s2-cs2103t-w12-4.github.io/tp/DeveloperGuide.html)_.

_This page is for ConnectCare users. If you're a developer, see also the
[Developer guide](https://ay2324s2-cs2103t-w12-4.github.io/tp/DeveloperGuide.html)._
</box>

<!-- * Table of Contents -->
Expand All @@ -25,7 +27,7 @@ ConnectCare is a powerful application designed to make social workers' lives eas
* Reduced Errors: Minimize the possibility of errors caused by switching between input methods.
* Boosted Productivity: Complete tasks faster and free up valuable time for client interaction.

**Embrace a Keyboard-Centric Approach**
### Embrace a Keyboard-Centric Approach

Social workers often spend significant time documenting and updating client information. By minimizing the need to use a mouse, ConnectCare allows for a smoother workflow, especially when working remotely or on laptops.

Expand All @@ -35,45 +37,46 @@ This approach can significantly reduce:
* Cognitive load from switching between input methods.
* Overall time spent completing tasks.

**Work Offline, Stay Productive**
### Work Offline, Stay Productive

One of the key benefits of ConnectCare is that it doesn't require a constant internet connection. This allows you to work seamlessly even in areas with limited or no internet access. Whether you're conducting a home visit or working remotely in the field, ConnectCare ensures you can access and update client information efficiently.

**Sensitive Data is kept Secure**
### Sensitive Data is kept Secure

We understand that social workers handle sensitive client information. Since ConnectCare functions offline, your data never needs to be transmitted over the internet or stored on remote servers. This significantly reduces the risk of unauthorized access compared to cloud-based solutions. ConnectCare prioritizes data security by storing information [locally](https://ay2324s2-cs2103t-w12-4.github.io/tp/UserGuide.html#local) on your device.
We understand that social workers handle sensitive client information. Since ConnectCare functions offline, your data never needs to be transmitted over the internet or stored on remote servers. This significantly reduces the risk of unauthorized access compared to cloud-based solutions. ConnectCare prioritizes data security by storing information [locally](#local) on your device.

**Focus on Your Clients, Not Software**
### Focus on Your Clients, Not Software

By streamlining workflows and offering social work-specific features, ConnectCare empowers you to focus on what matters most: your clients. You can spend more time building rapport with clients, respond to inquiries and needs more promptly and ultimately focus on delivering high-quality care.

## Who This Guide Is For

This guide does not assume any technical knowledge from users. We just require users to be able to type on a keyboard. As ConnectCare uses a [CLI](https://ay2324s2-cs2103t-w12-4.github.io/tp/UserGuide.html#cli), users who are familiar with a CLI would find it easy to transition to this software. However, if you have not used a CLI application before, there would be a step-by-step introduction in this guide for each command.
This guide does not assume any technical knowledge from users. We just require users to be able to type on a keyboard. As ConnectCare uses a [Command Line Interface (CLI)](#cli), users who are familiar with a CLI would find it easy to transition to this software. However, if you have not used a CLI application before, there would be a step-by-step introduction in this guide for each command.

## How to Use This Guide

There is no wrong way to read this guide: if you want to skip ahead, go for it! Each section is contained in itself, and you can find what you are looking for without needing to read the previous sections. However, we recommend that you read through the entire guide at least once before utilizing the application, so that you would have a more thorough understanding of the all necessary features.

This guide is comprised of 4 main sections:
1. The [**Quick Start**](https://ay2324s2-cs2103t-w12-4.github.io/tp/UserGuide.html#quick-start) section, we will walk through you in how to get started installing as well as running the ConnectCare on your own desktop
1. The [**Quick Start**](#quick-start) section, we will walk through you in how to get started installing as well as running the ConnectCare on your own desktop

2. The [**Features Section**](https://ay2324s2-cs2103t-w12-4.github.io/tp/UserGuide.html#features) will provide a comprehensive, easy-to-understand guide on how to fully make use of all of ConnectCare's functionalities and commands.
2. The [**Features Section**](#features) will provide a comprehensive, easy-to-understand guide on how to fully make use of all of ConnectCare's functionalities and commands.

3. The [**FAQ**](https://ay2324s2-cs2103t-w12-4.github.io/tp/UserGuide.html#faq) section will answer commonly asked questions, addressing potential further queries you might have!
3. The [**FAQ**](#faq) section will answer commonly asked questions, addressing potential further queries you might have!

4. Lastly, the [**Glossary**](https://ay2324s2-cs2103t-w12-4.github.io/tp/UserGuide.html#faq) contains a list of key terms and definitions that might be helpful
4. Lastly, the [**Glossary**](#glossary) contains a list of key terms and definitions that might be helpful

<box type="tip" seamless>
**Tip:** If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
<box type="warning" seamless>

**Warning:** If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
</box>

## Quick start

- Ensure Java 11 is installed in your computer. If it's not, install it [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html)
- Download the latest ConnectCare.jar
- Copy the jar file to the folder you want to use as the home folder
- Double click the file to start the application!
1. Ensure Java 11 is installed in your computer. If it's not, install it [here](https://www.oracle.com/sg/java/technologies/javase/jdk11-archive-downloads.html)
2. Download the latest ConnectCare.jar
3. Copy the jar file to the folder you want to use as the home folder
4. Double-click the file to start the application!

___

Expand Down Expand Up @@ -135,13 +138,48 @@ Examples: Lets say your contact list contains the following contacts: **John Doe
- `find Alex Lee` would return `Alex Lee`
- `find Lee` would return `John Lee` as well as `Alex Lee`

### Undoing a command : `undo`

_This command allows you to undo your last command, restoring the ConnectCare application to its previous state._

Format: `undo`

<box type="tip" seamless>

**Tip:**
The undo command does not undo every single command, only those that change the address-book in a significant way.
For a comprehensive deep-dive into the undo command, please refer to the [Implementation section of our Developer Guide](https://ay2324s2-cs2103t-w12-4.github.io/tp/DeveloperGuide.html)

</box>

_IMAGE_BEFORE and IMAGE_AFTER TBA_

### Redoing a command : `redo`

_This command allows you to redo your command, reversing any changes that were previously undone._

Format: `redo`

<box type="tip" seamless>

**Tip:**
The redo command does not redo every single command, only those that change the address-book in a significant way.
For a comprehensive deep-dive into the redo command, please refer to the [Implementation section of our Developer Guide](https://ay2324s2-cs2103t-w12-4.github.io/tp/DeveloperGuide.html)
</box>

_IMAGE_BEFORE and IMAGE_AFTER TBA_

### Clearing all entries : `clear`

This command allows you to purge your client list, removing **ALL** clients in your client list.

Format: `clear`

**Caution:** Only use this command if you are **absolutely** sure that you are willing to clear **all** of your clients from the list, as after running this command, any existing clients will be **unrecoverable**.
<box type="important" seamless>

**Caution:**
Only use this command if you are **absolutely** sure that you are willing to clear **all** of your clients from the list, as after running this command, any existing clients will be **unrecoverable**.
</box>

### Exiting the program : `exit`

Expand All @@ -154,15 +192,18 @@ _These are a list of helpful actions to facilitate the ease of use of our applic

#### Command Line Shortcuts


<box type="tip" seamless>

**Tip:** These shortcuts only work when the text box is selected
</box>

| Action | Description |
| --- | --- |
|`Up` | Displays to the previous command entered, if any. |
|`Down`| Displays the next command entered, if any. |
|`Tab`| Automatically completes commands, if available. |

| Action | Description |
|----------|---------------------------------------------------|
| `Up` | Displays to the previous command entered, if any. |
| `Down` | Displays the next command entered, if any. |
| `Tab` | Automatically completes commands, if available. |

### Saving the data

Expand All @@ -180,21 +221,26 @@ ___

## Command summary

| Action | Format | Examples |
| --- | --- | --- |
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… [k/NEXTOFKIN]` |`add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague` |
| **Update** | `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | `Update u/Jane Doe n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-011` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]` | `find James Jake` |
| **Undo** | `undo`| |
| **Redo** | `redo` | |
| **Display** | TBD | |
| **Clear** | `clear` | |
| **Exit** | `exit` | |
| Action | Format | Examples |
|-------------|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… [k/NEXTOFKIN]` | `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague` |
| **Update** | `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | `Update u/Jane Doe n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-011` |
| **Find** | `find KEYWORD [MORE_KEYWORDS]` | `find James Jake` |
| **Undo** | `undo` | |
| **Redo** | `redo` | |
| **Display** | TBD | |
| **Clear** | `clear` | |
| **Exit** | `exit` | |

___

## Glossary

### CLI
##### CLI
CLI stands for Command Line Interface, which is a way for you to interact with the application with only textual
commands, there is no need for a mouse. Once you learn the commands, CLIs can be faster for repetitive tasks than navigating menus with a mouse.
For more information, see also the [Wikipedia article for CLI](https://en.wikipedia.org/wiki/Command-line_interface)

### Local
##### Local
Local applications runs on the same computer it is launched on and there is no program or data that is being ran or transferred to another remote machine.
For more information, see also this [Microsoft article for Local and Remote execution](https://learn.microsoft.com/en-us/sql/integration-services/run-manage-packages-programmatically/understanding-the-differences-between-local-and-remote-execution?view=sql-server-ver16)

0 comments on commit 2ee009f

Please sign in to comment.