Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the UG #127

Merged
merged 4 commits into from
Mar 25, 2024
Merged

Improve the UG #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e761438
Update the UG
yisiox Mar 24, 2024
d2697c0
Improve using this guide section
yisiox Mar 24, 2024
f67d94d
Fix minor inconsistencies
yisiox Mar 25, 2024
33757e3
Fix mistake under edit
yisiox Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 118 additions & 42 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,99 @@

# AssetBook-3 User Guide

AssetBook-3 is a desktop application for logistics managers to keep track of contacts, along with assets for which they are responsible. It is meant for those who wish to easily retrieve contact details based on contact details and/or asset.
---

<!-- * Table of Contents -->
<page-nav-print />
## Introduction

--------------------------------------------------------------------------------------------------------------------
Welcome **logistics managers**! If you are someone who

1. manages logistics and inventory in a professional capacity,
2. is a fast typist, tired of shuffling back and forth between your mouse and keyboard,
3. is feeling swamped by the tedium of contact management on traditional office software...

breathe easy because AssetBook-3 is here!
Here to help streamline the task of *tracking contacts and which logistical assets they are in charge of*,
making your management tasks smoother than ever.

AssetBook-3 is designed to:
1. **Digitally Organize Your Contacts**: Say goodbye to scattered contacts; now, have them all organized and accessible in one place.
2. **Effortlessly Track All Your Assets**: Keep tabs on who is responsible for every piece of equipment and every item in your inventory.
3. **Maximize Your Operational Efficiency**: Our application, combined with your swift keyboard skills, turns the chore of contact management into a seamless and satisfying process!

---

## Quick start
## Using this Guide

This user guide contains all information needed to use AssetBook-3.
A [glossary](#glossary) is provided in case you encounter any unfamiliar terms.

#### New Users

Head over to the [quick start](#quick-start) to learn how to set up the application.
After which, you can have a look at the [features](#features) of AssetBook-3.

#### Experienced Users

Utilise the [table of contents](#table-of-contents)
or skip to the [command summary](#command-summary) to refresh your memory.

---

<!-- * Table of Contents -->
## Table of Contents
1. [Introduction](#assetbook-3-user-guide)
2. [Using this Guide](#using-this-guide)
3. [Table of Contents](#table-of-contents)
4. [Quick Start](#quick-start)
1. [Setting Up](#setting-up)
2. [Navigating the GUI](#navigating-the-gui)
5. [Navigating the GUI](#navigating-the-gui)
6. [Features](#features)
1. [Add](#adding-a-person-add)
2. [Delete](#delete-a-contact-or-asset-delete)
3. [Edit](#editing-a-contact-edit)
4. [Asset](#editing-an-asset-edita)
5. [Find](#locating-persons-by-name-or-asset-find)
6. [Undo](#undo-last-command-undo)
7. [Exit](#exiting-the-program-exit)
7. [Frequently Asked Questions](#faq)
8. [Known Issues](#known-issues)
9. [Command Summary](#command-summary)
10. [Glossary](#glossary)

---{.double}

## Quick Start

### Setting Up

1. Ensure you have Java `11` installed on your Computer.

1. Download the latest `assetbook.jar` from [here](https://github.com/AY2324S2-CS2103T-W12-3/tp/releases).
2. Download the latest `assetbook-3.jar` from [here](https://github.com/AY2324S2-CS2103T-W12-3/tp/releases).

1. Copy the file into the folder you want to use as the _home folder_.
3. Copy the file into the folder you want to use as the _home folder_.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar assetbook.jar` command to run the application.
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
4. Double-click on the `jar` file and a GUI similar to the below should appear in a few seconds.
Note how the app contains some sample data.
![Ui](images/Ui.png)

1. Refer to the [Features](#features) below for details of each command.
5. Refer to the [features](#features) below for details of each available command.

--------------------------------------------------------------------------------------------------------------------
<box type="tip" seamless>
Having trouble? Check the <a href="{{ baseUrl }}/UserGuide.html#faq">FAQ</a> section for resolutions to common problems.
</box>

### Navigating the GUI

Here are the components of the GUI.

1. **Input box**
2. **Command output box**
3. **Contacts list**
4. **Tags**
5. **Assets**

---{.double}

## Features

Expand All @@ -36,18 +107,18 @@ AssetBook-3 is a desktop application for logistics managers to keep track of con
**Notes about the command format:**<br>

* Items in square brackets are optional.<br>
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
e.g. `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.

* Items with `...` after them can be used multiple times including zero times.<br>
e.g. `[t/TAG]...` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
* Items followed by `...` indicates that it can be entered multiple times.<br>
e.g. `[t/TAG]...` can be used as `t/friend`, `t/friend t/colleague` etc.

* Parameters can be in any order.<br>
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.

* Extraneous parameters for commands that do not take in parameters (such as `exit`) will be ignored.<br>
e.g. if the command specifies `exit 123`, it will be interpreted as `exit`.

* 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.
* **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>

--------------------------------------------------------------------------------------------------------------------
Expand All @@ -60,7 +131,7 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]... [A/ASSET]...`

<box type="tip" seamless>

**Tip:** A person can have any number of assets (including 0)
**Tip:** A person can have any number of tags and assets (including 0)
</box>

#### Examples
Expand All @@ -69,7 +140,7 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]... [A/ASSET]...`
#### Options
`NAME`
* Name of the contact.
* Case sensitive, i.e. John Doe ≠ John Doe.
* Case sensitive, i.e. john doe ≠ John Doe.
* Leading and trailing spaces are automatically removed.
* Multiple people with the same name are allowed.

Expand All @@ -94,41 +165,41 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]... [A/ASSET]...`

--------------------------------------------------------------------------------------------------------------------

### Delete a contact or asset : `delete`
### Delete a contact or asset: `delete`

Delete a contact from the system by specifying its ID.

Format: `delete ID`
* `ID` refers to the unique contact index shown in the GUI.
Format: `delete INDEX`
* `INDEX` refers to the unique contact index shown in the GUI.
* The asset(s) associated with the contact will not be deleted.

#### Examples
`delete 1` deletes the contact with id `1`.
`delete 1` deletes the contact with index `1`.

--------------------------------------------------------------------------------------------------------------------

### Editing a contact : `edit`
### Editing a contact: `edit`

Edit existing contacts without recreating them.

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]... [A/ASSET]...`

Example: `edit 1 e/newemail@example.com` edits the contact with id `1`, changing its email to `newemail@example.com`.

* Edits the contact with the specified `id`. The `id` refers to the unique contact id shown by the GUI in the contacts list.
* Edits the contact with the specified `INDEX`. `INDEX` refers to the unique contact index shown in the GUI.
* At least one of the optional fields must be provided.
* Existing values will be updated to the input values.
* When editing assets, the existing assets of the person will be removed i.e adding of assets is not cumulative.
* You can remove all the person’s tags by typing `t/` without specifying any tags after it.
* You can remove all the person’s assets by typing `A/` without specifying any assets after it.

### Editing an asset: `edita`
### Editing an asset: `asset`

Edit existing assets without recreating them.

Format: `edita old/OLD_ASSET_NAME new/NEW_ASSET_NAME`
Format: `asset old/OLD_ASSET_NAME new/NEW_ASSET_NAME`

Example: `edita old/hammer new/screwdriver` edits the asset `hammer`, changing its name to `screwdriver`.
Example: `asset old/hammer new/screwdriver` edits the asset `hammer`, changing its name to `screwdriver`.

* The asset will be renamed for all contacts linked to it.

Expand All @@ -155,7 +226,7 @@ Format: `undo`

--------------------------------------------------------------------------------------------------------------------

### Exiting the program : `exit`
### Exiting the program: `exit`

Exits the program.

Expand All @@ -180,13 +251,13 @@ If your changes to the data file makes its format invalid, AssetBook will discar
Furthermore, certain edits can cause the AssetBook to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.
</box>

--------------------------------------------------------------------------------------------------------------------
---

### Archiving data files `[coming in v2.0]`
## Future Features

_Details coming soon ..._
+

--------------------------------------------------------------------------------------------------------------------
---{.double}

## FAQ

Expand All @@ -195,20 +266,25 @@ _Details coming soon ..._

--------------------------------------------------------------------------------------------------------------------

## Known issues
## Known Issues

1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.

--------------------------------------------------------------------------------------------------------------------
---{.double}

## Command summary

Action | Format | Examples
-----------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]... [A/ASSET]...` | `add n/John Doe e/johndoe@example.com p/+12345678 A/L293D`
**Delete** | `delete ID` | `delete 1`
**Edit contact** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]... [A/ASSET]...` | `edit 1 e/newemail@example.com`
**Edit asset** | `edita old/OLD_ASSET_NAME new/NEW_ASSET_NAME` | `edita old/hammer new/screwdriver`
**Find** | `find KEYWORD [KEYWORD]...` | `find John`
**Undo** | `undo` | `undo`
**Exit** | `exit` | `exit`
Action | Format | Example
-----------------|-------------------------------------------------------------------------------|---
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]... [A/ASSET]...` | `add n/John Doe e/johndoe@example.com p/+12345678 A/L293D`
**Delete** | `delete INDEX` | `delete 1`
**Edit contact** | `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]... [A/ASSET]...` | `edit 1 e/newemail@example.com`
**Edit asset** | `asset old/OLD_ASSET_NAME new/NEW_ASSET_NAME` | `asset old/hammer new/screwdriver`
**Find** | `find KEYWORD [KEYWORD]...` | `find John`
**Undo** | `undo` | `undo`
**Exit** | `exit` | `exit`

---{.double}

## Glossary

2 changes: 2 additions & 0 deletions docs/_markbind/layouts/default.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
<site-nav>
* [Home]({{ baseUrl }}/index.html)
* [User Guide]({{ baseUrl }}/UserGuide.html) :expanded:
* [Introduction]({{ baseUrl }}/UserGuide.html#introduction)
* [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start)
* [Features]({{ baseUrl }}/UserGuide.html#features)
* [FAQ]({{ baseUrl }}/UserGuide.html#faq)
* [Command Summary]({{ baseUrl }}/UserGuide.html#faq)
* [Glossary]({{ baseUrl }}/UserGuide.html#glossary)
* [Developer Guide]({{ baseUrl }}/DeveloperGuide.html) :expanded:
* [Acknowledgements]({{ baseUrl }}/DeveloperGuide.html#acknowledgements)
* [Setting Up]({{ baseUrl }}/DeveloperGuide.html#setting-up-getting-started)
Expand Down