Skip to content

Commit

Permalink
Merge pull request #18 from ZShunRen/website-dev
Browse files Browse the repository at this point in the history 
Change name in config file to product
  • Loading branch information
@FionaQY
FionaQY authored Oct 2, 2024
2 parents 160084d + ad05ccd commit 3b650bd
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 17 deletions.
34 changes: 25 additions & 9 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,13 @@ _{Explain here how the data archiving feature will be implemented}_

### Product scope

**Target user profile**:
**Banking Agents, that sell credit cards**:

* has a need to manage a significant number of contacts
* prefer desktop apps over other types
* can type fast
* prefers typing to mouse interactions
* needs a fast way to access data, and see relevant customer information at a glance while on a call with the customer
* is reasonably comfortable using CLI apps

**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
Expand All @@ -275,14 +276,29 @@ _{Explain here how the data archiving feature will be implemented}_

Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`

| Priority | As a …​ | I want to …​ | So that I can…​ |
| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
| `* * *` | new user | see usage instructions | refer to instructions when I forget how to use the App |
| `* * *` | user | add a new person | |
| `* * *` | user | delete a person | remove entries that I no longer need |
| `* * *` | user | find a person by name | locate details of persons without having to go through the entire list |
| `* *` | user | hide private contact details | minimize chance of someone else seeing them by accident |
| `*` | user with many persons in the address book | sort persons by name | locate a person easily |
| Priority | As a …​ | I want to …​ | So that I can…​ |
|----------|-----------------|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `* * *` | user | save current data | when I close & open the app, details I have added persist |
| `* * *` | user | be able to edit data of my customer | I can change customer details without having to delete a contact and re-add it with the new details |
| `* * *` | banking agent | add a customer | I can save the records and details of the new customer |
| `* * *` | banking agent | remove a customer | I can remove a customer that is no longer going to use our credit card services or is blacklisted |
| `* * *` | banking agent | view details of a customer | I need not ask customers for details again |
| `* * *` | banking agent | save contact details of the customers | I can contact customers who are more willing to spend money and call back customers with updates |
| `* * *` | banking agent | edit contact details of the customers | I need not delete and re-add a customer just for a small change in detail (i.e. moved house) |
| `* * *` | banking agent | delete contact details | I can remove customers who are no longer valid or for whatever reason are not worth saving |
| `* * *` | banking agent | save a note/remarks about the customers | I can recall any particular notable details about the customer (for e.g. This customer is very concerned about pricing) |
| `* *` | banking agent | check which credit card services or plans a customer has/had | I avoid selling products that the customer already has |
| `* *` | banking agent | filter using details like occupation and income | I can target a group of customers more quickly |
| `* *` | first time user | have a walkthrough guide to show me the user interface | I am familiar with the features available and how I can find and use them |
| `*` | user | export current data | I can backup the data regularly |
| `*` | user | import data from a backup | I can use my data backed up in case of data loss, or initialise the app with a set of data if I am transferring from a prior source |
| `*` | banking agent | view common urls/card information | I can read/send them to the customer quickly when inquired |
| `*` | banking agent | be reminded to call back a client when I open the application | I can immediately know which client I need to follow up today |
| `*` | impatient user | get the results that falls into a specific group/category | I don’t waste time querying all the result in that category one by one |
| `*` | impatient user | enter details quickly using a user-friendly interface | I can quickly add/view data and not get mad because it’s fast |
| `*` | long time user | access my most frequently used features easily | I can save time when accessing my most used features |
| `*` | beginner user | have a help menu | I know how to perform a particular task |
| `*` | beginner user | have some sample customer data that has already been inputted into the app | I can find out information can be saved in the application |

*{More to be added}*

Expand Down
17 changes: 15 additions & 2 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: page
title: User Guide
---

AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
AgentAssist is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AgentAssist can get your sales tasks done faster than traditional GUI apps.

* Table of Contents
{:toc}
Expand Down Expand Up @@ -130,7 +130,7 @@ Examples:
### Deleting a person : `delete`

Deletes the specified person from the address book.

`
Format: `delete INDEX`

* Deletes the person at the specified `INDEX`.
Expand All @@ -141,6 +141,19 @@ Examples:
* `list` followed by `delete 2` deletes the 2nd person in the address book.
* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command.

### Adding a remark to a contact: `remark`

Adds a remark to the specified person from the address book. If there's an existing remark, it is overwritten by the new remark.
Format: `remark INDEX [r/REMARK]`

* Adds a remark to the person at the specified `INDEX`.
* The index refers to the index number shown in the displayed person list.
* The index **must be a positive integer** 1, 2, 3, …​

Examples:
* `list` followed by `remark 2 r/He is very rich` adds the remark "He is very rich" to the 2nd person in the address book.
* `find Betsy` followed by `remark 1 r/"She is my friend"` adds the remark "She is my friend" to the 1st person in the results of the `find` command.

### Clearing all entries : `clear`

Clears all entries from the address book.
Expand Down
4 changes: 2 additions & 2 deletions docs/_config.yml
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: "AB-3"
title: "Agent-Assist"
theme: minima

header_pages:
Expand All @@ -8,7 +8,7 @@ header_pages:

markdown: kramdown

repository: "se-edu/addressbook-level3"
repository: "AgentAssist"
github_icon: "images/github-icon.png"

plugins:
Expand Down
Binary file modified docs/images/Ui.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 11 additions & 4 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
---
layout: page
title: AddressBook Level-3
title: AgentAssist
---

[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)

![Ui](images/Ui.png)

**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
**AgentAssist is a desktop application, designed for banking sales agents to help with managing their contact
details.**
While it
has a GUI, most of the user interactions happen using a CLI (Command Line Interface).

* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
* 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 about developing AgentAssist, the [**Developer Guide**](DeveloperGuide.html) is a good place to
start.


**Acknowledgements**

* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)

0 comments on commit 3b650bd

Please sign in to comment.