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

Update UG issues #145

Merged
merged 7 commits into from
Oct 31, 2022
Merged

Update UG issues #145

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5de6a18
Update User Guide
rylzxc Oct 31, 2022
30d934b
Update UG
rylzxc Oct 31, 2022
42d18b3
Update UG
rylzxc Oct 31, 2022
8ae54dd
Update UG
rylzxc Oct 31, 2022
0bafccd
Fix `DateTime` to not allow invalid dates
rylzxc Oct 31, 2022
462016b
Minor updates to UG
rylzxc Oct 31, 2022
1c18413
Minor UG fix
rylzxc Oct 31, 2022
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
143 changes: 80 additions & 63 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,47 @@ layout: page
title: User Guide
---

WorkBook (WB) is a **desktop app for CS/tech students who are applying for internships to manage their internship applications, 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, WB can get your internship management tasks done faster than traditional GUI apps.


<div class="toc-no-bullet-points">
* Table of Contents
{:toc}
</div>

--------------------------------------------------------------------------------------------------------------------
## 1. Introduction to WorkBook

WorkBook is an internship application tracker that helps Computing students **prepare sufficiently** for their upcoming interviews to **secure** that internship.
It is optimized for fast typists and replicates a Command Line Interface (CLI) style.


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

## Quick start
## 2. Get started

1. Ensure you have Java `11` or above installed in your Computer.
1. Ensure you have [Java 11 or above](https://www.oracle.com/sg/java/technologies/downloads/#java11) installed on your Computer.

2. Download the latest `workbook.jar` from [here](https://github.com/AY2223S1-CS2103T-T10-3/tp).
2. Download the latest `WorkBook.v1.3.1.jar` from [here](https://github.com/AY2223S1-CS2103T-T10-3/tp/releases/tag/v1.3.1).

3. Copy the file to the folder you want to use as the _home folder_ for your WorkBook.
3. Copy the file to a folder of your choice to store data from your WorkBook.

4. Using your favourite terminal, navigate to the _home folder_ above and start WorkBook by running `java -jar workbook.jar`. The GUI as shown below should appear in a few seconds. Note how the app contains some sample data.<br>
4. Using your command terminal, navigate to the folder where you placed your WorkBook at and fire it up by inputting: `java -jar WorkBook.v1.3.1.jar` in your terminal. <br> The GUI with sample data as shown below should appear in a few seconds.<br>
![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.<br>
5. Tell WorkBook what you want by typing your command in `Enter command here...` at the top of the application. <br>
Some example commands you can try:

* **`add`**`c/Meta d/2022-09-15 e/[email protected] r/Frontend` : Adds an internship from `Meta` to the WorkBook.
* `add c/Meta d/18-Oct-2022 12:00 e/[email protected] r/Frontend` : Adds an internship application from `Meta` to the WorkBook.

* **`delete`**`3` : Deletes the 3rd internship shown in the current list.
* `delete 3` : Deletes the 3rd internship shown in the current list.

* **`clear`** : Deletes all internships.
* **`help`** : Displays the help window for easy reference to the list of commands.

* **`exit`** : Exits the app.

1. Refer to the [Features](#features) below for details of each command.
6. Refer to the [things to note](#3-things-to-note) below for details of each command.

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

## Features
## 3. Things to note

<div markdown="block" class="alert alert-info">

Expand All @@ -50,55 +56,63 @@ WorkBook (WB) is a **desktop app for CS/tech students who are applying for inter
e.g `c/COMPANY [t/TAG]` can be used as `c/Meta t/unattainable` or as `c/Meta`.

* 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/unattainable`, `t/unattainable t/AWS` etc.
e.g. `[t/TAG]…​` can be omitted, used once: `t/unattainable`, or multiple times: `t/unattainable t/AWS`.

* Parameters can be in any order.<br>
e.g. if the command specifies `c/COMPANY s/STAGE`, `s/STAGE c/COMPANY` is also acceptable.

* If a parameter is expected only once in the command but you specified it multiple times, only the last occurrence of the parameter will be taken.<br>
* If a parameter is expected only once in the command, but you specified it multiple times, only the last occurrence of the parameter will be taken.<br>
e.g. if you specify `r/Frontend r/Backend`, only `r/Backend` will be taken.

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

</div>

## Command summary
## 4. What you can do

| Action | Format, Examples |
|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Action | Command format <br> e.g. `Example command` |
|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Add** | `add c/COMPANY r/ROLE s/STAGE [d/DATE] [e/COMPANY_EMAIL] [l/LANGUAGE TAG]… [t/TAG]…​` <br> e.g., `add c/Bytedance r/Backend Engineer s/Online Assessment d/24-Sep-2022 15:00 t/high pay l/Javascript` |
| **Edit** | `edit INDEX [c/COMPANY] [d/YYYY-MM-DD] [e/EMAIL] [r/ROLE] [l/LANGUAGE TAG]… [t/TAG]…​​`<br> e.g.,`edit 2 c/Meta e/[email protected]` |
| **List** | `list` |
| **Find** | `find c/COMPANY | r/ROLE | s/STAGE​​`<br> e.g.,`find c/Meta`
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **Undo** | `undo` |
| **Redo** | `redo` |
| **Clear** | `clear` |
| **Help** | `help` |
| **Exit** | `exit` |
| **Edit** | `edit INDEX [c/COMPANY] [d/DATE] [e/COMPANY_EMAIL] [r/ROLE] [l/LANGUAGE TAG]… [t/TAG]…​​`<br> e.g.,`edit 2 c/Meta e/[email protected]` |
| **Find** | `find c/COMPANY` | r/ROLE | s/STAGE​​`<br> e.g.,`find c/Meta`
| **Delete** | `delete INDEX`<br> e.g., `delete 3` |
| **List** | `list` |
| **Undo** | `undo` |
| **Redo** | `redo` |
| **Clear** | `clear` |
| **Help** | `help` |
| **Exit** | `exit` |

<div markdown="block" class="alert alert-info">

**:information_source: Note:**<br>

* Commands without examples are considered trivial and can be executed by inputting the command without additional parameters.
* Commands are **case-sensitive**!

</div>

### Adding an internship application: `add`
### 4.1. Adding an internship application: `add`

Adds an internship application to WorkBook.

Format: `add c/COMPANY r/ROLE s/STAGE [d/DATE] [e/COMPANY_EMAIL] [l/LANGUAGE TAG] [t/TAG]…​`

* Adds an internship application to the list in sorted order.
* Fields not square-bracketed are mandatory.
* Date must be properly formatted (DD-MMM-YYYY HH:mm) when inputted.
* Date can represent the date it happened or the deadline of the corresponding `stage`
* Email domain, if included, must be properly formatted ([email protected]).
* An application can have any number of tags and language tags and are added one by one (i.e.
if you want 2 tags, you have to specify `t/two t/tags`).
* Note: Internship applications **in the past** are placed at the bottom.
* Date can represent:
* The date it happened
* The deadline of the corresponding `Stage`
* Date, if included, must be properly formatted `DD-MMM-YYYY HH:mm` when inputted.
* Email domain, if included, must be properly formatted `[email protected]`.
* Square-bracketed fields are optional.

Examples:
* `add c/Meta r/Frontend Engineer s/Application Sent d/29-Oct-2022 12:00 e/[email protected]`
* `add c/Bytedance r/Backend Engineer s/Online Assessment d/24-Sep-2022 15:00 t/high pay l/Java l/Python`

### Editing a person : `edit`
### 4.2. Editing a person : `edit`

Edits an existing person in the WorkBook.

Expand All @@ -115,13 +129,13 @@ Examples:
* `edit 1 s/Behavioural Interview e/[email protected]` Edits the stage and email address of the first internship to be `Behavioural Interview` and `[email protected]` respectively.
* `edit 2 l/golang t/` Adds `golang` as the only language tag for the second internship and clears all existing tags.

### Listing all existing internship applications : `list`
### 4.3. Listing all existing internship applications : `list`

Lists all internship applications in the Workbook.

Format: `list`

### Finds internships by company, stage or role name: `find`
### 4.4. Finds internships by company, stage or role name: `find`

Finds internships whose company, role or stage names contain any of the respective keywords.

Expand All @@ -138,7 +152,7 @@ Examples:
* `find r/Engineer` returns `Software Engineer` and `Backend Engineer`.
* `find s/Interview` returns `Technical Interview` and `Behavioural Interview`.

### Deleting an internship application : `delete`
### 4.5. Deleting an internship application : `delete`

Deletes the specified internship application from WorkBook.

Expand All @@ -152,7 +166,7 @@ Examples:
* `list` followed by `delete 2` deletes the 2nd internship application in WorkBook.
* `find Meta` followed by `delete 1` deletes the 1st internship application within the results of the `find` command.

### Clearing all existing internship applications : `clear`
### 4.6. Clearing all existing internship applications : `clear`

Clears all internship applications in the Workbook.

Expand All @@ -161,7 +175,7 @@ Format: `clear`
Example:
* `clear` removes all internship applications in the workbook.

### Undoing previous command: `undo`
### 4.7. Undoing previous command: `undo`

Restores the work book to the state before the previous <em>undoable</em> command was executed

Expand Down Expand Up @@ -194,7 +208,7 @@ Examples:

`undo` (reverses the `delete 1` command )

### Redoing previous command: `redo`
### 4.8. Redoing previous command: `redo`

Reverses the most recent `undo` command.

Expand Down Expand Up @@ -227,7 +241,7 @@ Examples:

`redo`(reapplies the `clear` command)

### Viewing help : `help`
### 4.9. Viewing help : `help`

Shows a summary of the commands as well as a link to this User Guide.

Expand All @@ -236,47 +250,50 @@ Format: `help`
Example:
* `help`

### Exiting the program : `exit`
### 4.10. Exiting the program : `exit`

Exits the program.

Format: `exit`

### Saving the data
### 4.11. Daily Tips `[coming soon]`

WorkBook data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.

### Editing the data file

WorkBook data is saved as a JSON file [JAR file location]/data/workbook.json. Advanced users are welcome to update data directly by editing that data file.
_Details coming soon ..._

<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
If your changes to the data file makes its format invalid, WorkBook will discard all data and start with an empty data file at the next run.
</div>
--------------------------------------------------------------------------------------------------------------------

## 5. Managing your data

### Ranking internships `[coming soon]`
### 5.1. Saving

_Details coming soon ..._
Conveniently, any inputted command that changes any part of your internship application is **automatically saved**!
Hence, you need not worry about pressing `ctrl` and `s` everytime you update your list of internship applications.

### Sorting internships `[coming soon]`
### 5.2. Editing

_Details coming soon ..._
All your internship applications are saved in a JSON file under the `data` subfolder.
You are free to update any internship application directly by editing that JSON file.

### Daily Tips `[coming soon]`
<div markdown="block" class="alert alert-info">

_Details coming soon ..._
**:information_source: JSON?:**<br>
* JSON stands for JavaScript Object Notation, learn how to edit the file [here](https://www.softwaretestinghelp.com/how-to-open-a-json-file/)!

### Toggling Light and Dark mode `[coming soon]`
</div>

_Details coming soon ..._
<div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
If your changes to the data file makes its format invalid, WorkBook will discard all data and start with an empty data file at the next run.
</div>

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

## FAQ
## 6. Frequently asked questions

**Q**: How do I transfer my data to another Computer?<br>
**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous WorkBook home folder.
**A**: [Install](#2-get-started) the app in the other computer, copy and override the JSON file in the new `data` subfolder, and you are done!

**Q**: How do I change the theme of WorkBook?<br>
**A**: It is not possible as of now, but will be coming soon!

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

Expand Down