diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 8655b6ad241..10b8a9c4572 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -3,29 +3,85 @@ layout: page title: User Guide --- -Do you have trouble managing contacts? +Are you a School of Computing (SoC) Computing Club event planner juggling numerous tasks and contacts for your upcoming events? -Don't worry, CoordiMate is here to help! +Managing everything efficiently just got easier with CoordiMate! -CoordiMate is a **desktop app for event planners**. It helps you **manage your contacts and tasks** for your events, so that you can focus on the event itself. +CoordiMate is your go-to **desktop app** designed specifically for **SoC Computing Club event planners** to help you **manage your contacts and tasks** for your events, so that you can focus on the event itself. -CoordiMate is **optimized for use via a Command Line Interface (CLI)** while still having the benefits of a Graphical User Interface (GUI). +And here's the best part – while it's perfect for members of SoC Computing Club, **event planners of all kinds** can benefit from CoordiMate's powerful features too! -If you can type fast, CoordiMate can help you get your contact management tasks done **faster than traditional GUI apps**. +

Why choose CoordiMate?

-This user guide contains all the information you need to get started with CoordiMate. +1. **User-Friendly Command Line Interface (CLI)**: CoordiMate is optimized for use via a CLI, combining all the benefits of a Graphical User Interface (GUI) with the efficiency of a CLI. -

Table of Contents

-* Table of Contents +2. **Speedy Navigation**: If you're a fast typist, CoordiMate will help you complete your contact and tasks management faster than traditional GUI apps, maximising your productivity. + +Don't let the stress of contact and task management hinder your event planning creativity. + +Let **CoordiMate** take care of the details, while you craft extraordinary events with confidence. + +## Using This Guide + +This document will guide you on the various features of CoordiMate and how to use them. + +If you are a new user, we recommend that you read this guide starting from the [Quick Start](#quick-start) section. + +If you are an experienced user, you can use the [Table of Contents](#table-of-contents) below to quickly locate the relevant section. Alternatively, you can jump to the [Command Summary](#command-summary) section for an overview of the command syntax. + +Here are some annotations used in this guide: + +{% include admonition.html type="danger" title="Danger" body=" + +Be careful when performing these operations as they can lead to data loss. + +" %} + +{% include admonition.html type="warning" title="Warning" body=" + +Take note of these as they can cause unexpected behaviour when using CoordiMate. + +" %} + +{% include admonition.html type="note" title="Note" body=" + +Contains useful information to help you use CoordiMate better. + +" %} + +{% include admonition.html type="question" title="Question" body=" + +Answers to frequently asked questions about CoordiMate. + +" %} + +{% include admonition.html type="bug" title="Known Issue" body=" + +Known issues that you may face when using CoordiMate and how to resolve them. + +" %} + +Throughout this guide, you will see different text styles that are used to highlight important information. + +- Text in blue are links which you can click on to jump to the relevant section. +- `Text with light blue background` are commands or file names which are used for CoordiMate. + +--- + +
+ +## Table of Contents + +- Table of Contents {:toc} ---
-## Quick start +## Quick Start -1. Ensure you have Java `11` or above installed in your Computer. +1. Ensure you have Java `11` or above installed in your computer. 2. Download the latest `CoordiMate.jar` from [here](https://github.com/AY2324S1-CS2103T-T10-2/tp/releases). @@ -33,27 +89,28 @@ This user guide contains all the information you need to get started with Coordi 4. Open a command terminal, `cd` into the folder you put `CoordiMate.jar` in, and use the `java -jar CoordiMate.jar` command to start CoordiMate.
- A GUI similar to the below picture should appear in a few seconds. Note how the app contains some sample data.
+ A GUI similar to the below screenshot should appear in a few seconds. Note how the app contains some sample data.

![Ui](images/Ui.png) -5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.
+5. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.

+ Some example commands you can try: - * `listPerson` : Lists all persons. + - `listPerson` : Lists all persons. - * `addPerson n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a new contact named `John Doe` with the specified details. + - `addPerson n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a new contact named `John Doe` with the specified details. - * `deletePerson 3` : Deletes the 3rd contact shown in the current contact list. + - `deletePerson 3` : Deletes the 3rd contact shown in the current contact list. - * `listTask` : Lists all tasks. + - `findTask caterer` : Finds all tasks with the word `caterer` in their title or note. - * `addTask t/Get Flowers n/Wedding Anniversary` : Adds a task titled `Get Flowers` with note `Wedding Anniversary` to the task list. + - `listTask` : Lists all tasks. - * `markTask 1` : Marks the 1st task shown in the current task list as done. + - `addTask T/Get Flowers n/Wedding Anniversary` : Adds a task titled `Get Flowers` with note `Wedding Anniversary` to the task list. - * `findTask Get` : Finds all tasks with the word `Get` in their title or note. + - `markTask 1` : Marks the 1st task shown in the current task list as done. - * `exit` : Exits the app. + - `exit` : Exits the app. 6. Refer to the [Usage](#usage) section below for details of each command. @@ -63,18 +120,27 @@ This user guide contains all the information you need to get started with Coordi ## Features -1. Create, Read, Update, Delete (CRUD) Person -2. Find Person -3. CRUD Task -4. Find Task -5. Automatic saving and loading of data from save file - 1. CoordiMate automatically saves its data as a JSON file located at `[JAR file location]/data/CoordiMate.json`. - 2. There is no need to save manually. - 3. On startup, CoordiMate will automatically load existing data (if any) from the JSON file. -6. Editable file format - 1. Advanced users are welcome to update data directly by editing that data file. - -{% include admonition.html type="danger" title="Potentially Dangerous Operation!" body=" +1. **Easy Management of People**: + - Seamlessly create, update, and delete person records. CoordiMate ensures your contact list is always up-to-date, putting people at the heart of your event planning. +2. **Quick Person Search**: + - Find specific individuals effortlessly. No more digging through piles of data. With CoordiMate, finding the right person is just a search away, making your interactions more personal and meaningful. +3. **Effortless Task Control**: + - Manage tasks without the fuss. CoordiMate's intuitive interface lets you handle tasks with ease. From creation to completion, stay in control of every event detail. +4. **Simplified Task Tracking**: + - Easily locate tasks based on your criteria. CoordiMate streamlines your search, ensuring you stay organized and focused on tasks that matter most to you and your attendees. +5. **Hassle-Free Data Handling**: + - Automatic Data Management: + - CoordiMate takes care of saving and loading data for you. No need to worry about manual saves; your information is secure and ready whenever you are. + - Saved data safely as a JSON file located at `[JAR file location]/data/CoordiMate.json`. + - Startup Ready: + - Instantly pick up where you left off. CoordiMate loads your existing data upon startup, eliminating downtime and ensuring you're always in the loop. +6. **Empowering User Control**: + - Editable File Format: + - For advanced users, CoordiMate offers complete data control. Tailor your event data directly by editing the data file, putting you in charge of your event management. + +With these user-centric features, CoordiMate empowers you to focus on what truly matters: creating exceptional events and nurturing valuable connections. Experience event planning made personal, efficient, and stress-free with CoordiMate! + +{% include admonition.html type="danger" title="Danger" body=" If your changes to the data file makes its format invalid, CoordiMate will discard all data and start with an empty data file at the next run. @@ -88,7 +154,7 @@ Always make a backup before you edit! ## Usage -{% include admonition.html type="info" title="Info: About Command Formats" body=" +{% include admonition.html type="note" title="Note" body="