diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 6a78c06bde5..5de8097953d 100644 --- a/docs/AboutUs.md +++ b/docs/AboutUs.md @@ -5,7 +5,7 @@ title: About Us We are a team based in the [School of Computing, National University of Singapore](https://www.comp.nus.edu.sg). -You can reach us at the email `seer[at]comp.nus.edu.sg` +You can reach us at the email `agentassist@comp.nus.edu.sg` ## Project team diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7520caf809f..4a01df55111 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -5,7 +5,7 @@ title: User Guide ![Banner](images/AgentAssistBanner.png) # Welcome to the AgentAssist User Guide! -The **AgentAssist User Guide** is here to help you unlock the full potential of **AgentAssist** and take your credit card sales to the next level. This guide offers clear, step-by-step instructions and practical examples to help you get the most out of the application. +The **AgentAssist User Guide** is here to help you unlock the full potential of AgentAssist and take your credit card sales to the next level. This guide offers clear, step-by-step instructions and practical examples to help you get the most out of the application. In this guide, you'll learn how to: * **Set Up AgentAssist** to be used to manage clients. @@ -194,10 +194,10 @@ Each client’s tier is represented with a color-coded label located beside thei #### ⬤ Reject Tier -Clients that are not being assigned to any tier (**NA** tier) will not display a tier label on the UI. +Clients that are not assigned to any tier (**NA** tier) will not display a tier label on the UI. ### Status Color Code of AgentAssist GUI: -Case statuses are also color-coded and appear next to a client’s name in the list or below their name in the Client Detail Panel. This system indicates the urgency level of each client’s case, helping you prioritize tasks. +Case statuses are also color-coded and appear next to a client’s name in the list or below their name in the Client Detail Panel. This visual aid indicates the urgency level of each client’s case, helping you prioritize tasks. #### ⬤ Urgent Status #### ⬤ Non-Urgent Status @@ -214,7 +214,7 @@ To learn more about how to use commands in AgentAssist, proceed to the next sect # 4. Understanding Commands in AgentAssist -The true power of **AgentAssist** lies in efficiently using commands. Before diving into specific commands, let’s break down the basic structure of a command. +The true power of AgentAssist lies in efficiently using commands. Before diving into specific commands, let’s break down the basic structure of a command. ## 4.1 Command Structure Overview Each command in AgentAssist consists of three key components: the **command**, **flag(s)**, and **argument(s)**. @@ -290,7 +290,7 @@ Here’s a reference table of available flags and the type of data they correspo Arguments are the values that are used in a command. - Arguments typically follow after a corresponding flag, with the exception of ``. - **Arguments cannot be empty** and each must meet specific parsing and format requirements to ensure proper execution of the command. -- When an argument is entered, any spaces before or after the argument are **ignored**. Example: `add n/ John Doe` and `add n/John Doe` are equivalent. Both pass the argument value of `John Doe`. +- When an argument is entered, any spaces before or after the argument are **ignored**. For example, `add n/ John Doe` and `add n/John Doe` are equivalent. Both pass the argument value of `John Doe`. - In this guide we often add a space before any arguments to improve readability, however this is purely cosmetic (i.e., it is still correct without a space). ### 4.4.1 Flag Arguments @@ -321,7 +321,7 @@ Refer to the table below for more details. > > Providing a flag without an accompanying argument will result in an error and prevent the command from executing properly. -### 4.4.2 Non-Flag Arguments +### 4.4.2 Non-Flag Arguments Non-flag arguments are the values that do not have a corresponding tag. Currently, this only includes the `` argument. @@ -388,7 +388,7 @@ Refer to the [Commands Section](#5-commands) for more comprehensive details of e ## 5.1 How to Read Commands -When working with commands in **AgentAssist**, it's important to understand **how the command format is structured**. Commands consist of specific components like **flags** and **arguments**, and some parts of the command can be **optional**. +When working with commands in AgentAssist, it's important to understand **how the command format is structured**. Commands consist of specific components like **flags** and **arguments**, and some parts of the command can be **optional**. If you're unfamiliar with how commands are structured, refer back to the [Command Structure Overview in Section 4.1](#41-command-structure-overview) for more details on how flags, arguments, and placeholders work together. @@ -477,7 +477,7 @@ Refer to Sections [4.3 Flags](#43-flags) and [4.4 Arguments](#44-arguments), for > > If you need to update details for an existing contact, use the `edit` command instead. > For more information, see Section [5.2.2 Editing a client](#522-edit-an-existing-clients-information). -- **Note:** If the value for either `Tier` and `Status` is the default value (`NA`), they will not be shown. +- If the value for `Tier`, `Status` or `Remark` is the default value (`NA`), they will not be shown. @@ -493,7 +493,7 @@ edit [n/ ] [p/ ] [e/ ] [a/
] [j/ ] [i/ ``` - Mandatory Field: ``, at least one of the Optional Fields - **Note:** The provided index must be **greater than 0**, and **less than or equal to the total number of clients in the list**. - - More details can be found in [Section 4.4.2 Non-Flag Arguments](#442-non-flag-arguments-). + - More details can be found in [Section 4.4.2 Non-Flag Arguments](#442-non-flag-arguments). - Optional Fields: `n/`, `p/`, `e/`, `a/`, `j/`, `i/`, `t/`, `rn/`, `ra/`, `s/` - **Note:** `rn/` (new remark(s)) and `ra/` (append remark(s)) cannot be used simultaneously in a single command. Additional, if multiple remarks are added using the `ra/` prefix, only the first 3 remarks will be shown in the list view and the rest can only be seen after using the [view command](#541-viewing-a-clients-details). @@ -548,7 +548,7 @@ For detailed explanations of each flag and acceptable arguments, refer to Sectio > 💡 **Pro Tip:** > No need to worry about duplicate indexes—AgentAssist guarantees that every client has a unique index automatically. -- **Note:** If the value for `Tier`, `Status` or `REMARK` is the default value (`NA`), they will not be shown. +- **Note:** If the value for `Tier`, `Status` or `Remark` is the default value (`NA`), they will not be shown. - This can be used to remove all remarks for a given client: `edit rn/ NA` . @@ -564,7 +564,7 @@ delete ``` * Mandatory Field: `` - **Note:** The provided index must be **greater than 0**, and **less than or equal to the total number of clients in the list**. - - More details can be found in [Section 4.4.2 Non-Flag Arguments](#442-non-flag-arguments-). + - More details can be found in [Section 4.4.2 Non-Flag Arguments](#442-non-flag-arguments). * After entering the command, you will be asked for confirmation (y/yes) before deletion occurs. For detailed explanations of each flag and acceptable arguments, refer to Sections [4.3 Flags](#43-flags) and [4.4 Arguments](#44-arguments) @@ -660,7 +660,7 @@ filter [n/ ] [p/ ] [e/ ] [a/
] [j/ ] [r/ `, or `<` to specify criteria. - - Example: `i/ >5000` will filter clients with an income greater than 5000. + - **Example:** `i/ >5000` will filter clients with an income greater than 5000. - See [Matching Criteria for Income](#filter-by-income) for more information. For detailed explanations for the matching criteria of each flag and the acceptable arguments, scroll down to **Matching Criteria & Filter Behavior** and refer to Sections [4.3 Flags](#43-flags) and [4.4 Arguments](#44-arguments) @@ -697,8 +697,8 @@ For detailed explanations for the matching criteria of each flag and the accepta - To filter by phone number, enter a complete and valid phone number (refer to [4.4 Arguments](#44-arguments)). This filter requires an exact match with the specified phone number. - **Example:** If a client’s phone number is `92601234`, only the exact format `92601234` will match. Variations such as `82601234` will not match, and inputs that are not valid phone numbers, like `9260`, `9260 1234`, or `12601234`, will not be accepted. -- **Tier (Prefix Matching):** - - Tier filtering use **prefix matching**, meaning the search term must match the beginning of the tier exactly. +- **Tier/Status (Prefix Matching):** + - Searches in these fields use **prefix matching**, meaning the search term must match the beginning of the field exactly. - **Example:** If a client has a tier labeled `Gold`, a search for `t/ G` or `t/ Gold` will match, but `t/ ld` or `t/ Gold Premium` will not. @@ -752,7 +752,7 @@ view ``` * Mandatory Field: `` - **Note:** The provided index must be **greater than 0**, and **less than or equal to the total number of clients in the list**. - - More details can be found in [Section 4.4.2 Non-Flag Arguments](#442-non-flag-arguments-). + - More details can be found in [Section 4.4.2 Non-Flag Arguments](#442-non-flag-arguments). **Examples:** - **View client no.1** diff --git a/docs/images/colinhia.png b/docs/images/colinhia.png index 941ed10dd3d..31d45770a49 100644 Binary files a/docs/images/colinhia.png and b/docs/images/colinhia.png differ diff --git a/docs/index.md b/docs/index.md index 4f5362675af..94c4d7337e0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,8 +12,7 @@ title: AgentAssist details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface). -* If you are interested in using AgentAssist, head over to the [_Quick Start_ section of the **User Guide**](UserGuide. - html#quick-start). +* If you are interested in using AgentAssist, head over to the [_Getting Started_ section of the **User Guide**](UserGuide.md#3-getting-started). * If you are interested about developing AgentAssist, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.