Skip to content

Commit 7303823

Browse files
committed
Add starter guide
1 parent f76a533 commit 7303823

File tree

4 files changed

+38
-86
lines changed

4 files changed

+38
-86
lines changed

docs/UserGuide.md

Lines changed: 38 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -62,116 +62,68 @@ Jobby comes equipped with a [GUI]() interface that provides visual feedback to y
6262
Hello and welcoem to Jobby! We are delighted that you've chosen our platform to manage your internship application process!
6363

6464
Before we begin, please ensure that you have viewed the following sections of the guide:
65-
* [Quick Start]() to help you get Jobby up and running
66-
* [Navigating the Interface]() to get you familiarised with navigating Jobby
65+
* [Installation](#installation) to help you get Jobby up and running.
66+
* [Navigating the Interface](#navigating-the-interface) to get you familiarised with navigating Jobby.
6767

6868
This tutorial aims to guide you through the most essential features and functionalities of Jobby that you will use on a day-to-day
6969
basis. In this guide, you will learn how to add your first tutor and corresponding schedule!
7070

7171
Click on any of the hyperlinks below to jump to respective sections of the tutorial!
72-
* Beginning
73-
* Adding your first contact
74-
* Adding your first application
72+
* [The Beginning](#beginning)
73+
* [Adding your first Organization](#adding-your-first-organization)
74+
* [Adding your first Recruiter](#adding-your-first-recruiter)
75+
* [Adding your first Application](#adding-your-first-application)
7576

76-
Jobby comes equipped with a [GUI]() interface that provides visual feedback to you. Below is a quick overview of the various components of our interface.
77-
78-
![ui overview](images/ug-images/labelled-gui.png)
79-
80-
### Adding `Contact`
81-
Jobby can create `Contacts`. In the form of `Organization` and `Recruiter`, which you can add into your database with simple CLI commands.
82-
83-
Let's say you want to track your job application for the `Organization: Woogle`, with a `Recruiter: John`.
84-
85-
You can add the `Organization` into Jobby with a simple command:
86-
```add --org --name Woogle --id woogle_id```
87-
88-
![Add Organization](images/starter-guide/add-woogle.jpg)
89-
90-
91-
You can then add a **recruiter** that's related to the "Woogle" organization like so::
92-
```add --rec --name John --id john_id --oid woogle_id```
93-
94-
![Add Recruiter](images/starter-guide/add-john.jpg)
95-
96-
97-
> To find out all of `Organization` and `Recruiter`'s flags, go [organization documentation]()
98-
> and [recruiter documentation]()
99-
100-
### Adding `Application`
101-
Let's say now you want to apply to `Woogle` for the position of `Junior Software Engineer` role. You will be able to create
102-
an `Application` for this company with the by including the `Organization ID` in the command:
103-
`apply woogle_id --title Software Engineer --by 22-11-2023`
104-
105-
![Add Application](images/starter-guide/add-application.jpg)
77+
### The Beginning
78+
When you first launch Jobby, you will notice that it comes preloaded with sample data for you to play with. You may use
79+
the sample data to familiarise yourself with the various [features](#features) that Jobby provides.
10680

107-
`Application` will automatically generates the fields if there are no inputs on your end.
108-
- `Status: Pending`
109-
- `Stage: Resume`
81+
Once you're ready to start using Jobby for your internship tracking, you can easily remove the sample data:
82+
1. type `clear` into the command box
83+
2. Hit `enter`
11084

111-
> You will be able to add different details of `Application`, see the [applcation documentation]() here.
85+
Solid! Now it's time to get started with Jobby!
11286

113-
### Editing `Contact`
114-
Now that you have both your Contacts and Applications. You received new informations about your `Contacts`, you will have to edit your `Contact` data.
87+
### Adding your first Organization
11588

116-
We can do so with the `edit` CLI command with the desired id and input.
89+
Let's say you are interested to applying to **Google** as your internship destination, and you found their email **google@gmail.com**.
11790

118-
Let's say we want to change the phone detail of `Organization: Woogle` and email of `Recruiter: John`.
119-
We can use the commands:
120-
`edit woogle_id --phone 12345678` and `edit john_id --email john@gmail.com`
91+
You can use [add --org](#adding-organizations---add---org) command here to add Google into your organization:
92+
1. type `add --org --name Google --id google_id --email google@gmail.com` into the command box
93+
2. press `enter`
12194

122-
![Edit Contact](images/starter-guide/edit-john.jpg)
95+
![Adding Organization](images/ug-images/org-added.png)
12396

97+
You have successfully added **Google**, with the email **google@gmail.com** into your **organization contact**!
12498

125-
After executing the commands,
126-
`Organization: Woogle`'s number changed to `phone: 12345678`.
127-
`Recruiter: John`'s email changed to `Email: john@gmail.com`.
99+
### Adding your first Recruiter
128100

129-
> To find more ways to `edit` `Organization` and `Recruiter`, see the [edit documentation](LINK TO ORGANIZATION AND RECRUITER DOCUMENTATION)
130-
131-
### Editing `Application`
132-
For your `Woogle` application, you managed to pass the resume screening stage! And you will have to change your `Stage` to
133-
the `Interview` stage.
134-
135-
You will be able to do it simply with:
136-
`edit --application 5 --stage interview`
137-
138-
![edit application](images/starter-guide/edit-application.jpg)
139-
140-
141-
This will change your `Stage` from `Resume` to `Interview`, indicating that you are onto the next stage of the application process.
142-
> To find more fields of the `Application` to edit, see the [edit documentation](LINK TO EDIT APPLICATION DOCUMENTATION)
143-
144-
### Get `Reminder`
145-
During your internship application process, you might feel that there are many deadlines that you have to keep track of,
146-
in Jobby, we have a `Remind` command that will help you sort your applications by their `Deadlines`.
147-
148-
You can do so with a simple command:
149-
`remind --earliest`
150-
to see your application deadlines from the earliest to latest.
151-
152-
![Remind Earliest](images/starter-guide/remind-earliest.jpg)
153-
154-
155-
> To find out more ways to use `remind`, see the [remind documentation](LINK TO REMIND DOCUMENTATION).
156-
157-
### Finding `Organization` and its related `Applications
158-
Let's say there is a specific organization application you are looking for, like **Woogle**, you will be able to easily find it via
159-
this command:
160-
```
161-
find woogle
162-
```
101+
In a job fair, you managed to meet a **Google** internship recruiter, **Josh Mao**, and he provided you with his number
102+
**91219121**.
163103

164-
SCREENSHOT
104+
Here is how you can use [add --rec](#adding-recruiters---add---rec) command to track the Recruiter data in Jobby:
105+
1. type `add --rec --name Josh Mao --oid google_id --phone 91219121` into the command box
106+
2. press `enter`
165107

166-
> To find out more ways to use `find`, see the [find documentation](LINK TO find DOCUMENTATION).
108+
![Adding Recruiter](images/ug-images/rec-added.png)
167109

110+
You have successfully added **Josh Mao**, who is a **recruiter** from Google, whose number is **91219121**.
168111

112+
### Adding your first Application
169113

114+
After preparing your resume, you are ready to apply to **Google** as an intern for their **Software Engineer** role! And you know that the application deadline is on the **2-11-2023**.
170115

171-
![List](images/starter-guide/list.jpg)
116+
In order to track your application, you can use [apply](#applying-to-organizations---apply) to track your application:
117+
1. type `apply google_id --title Software Engineer --by 22-11-2023` into the command box
118+
2. press `enter`
172119

120+
![Adding Application](images/ug-images/app-added.png)
173121

122+
You managed to add your application to **Google**! With the role you are interested in, **Software Engineer** and the application deadline which is **22-11-2023**.
174123

124+
**Congratulations!** You have ran through the basics of Jobby. We hope that this tutorial has gave you an understanding of the
125+
basic workflow of Jobby. However, there are still many features that we have yet introduced. Please refer to the [Using Jobby Section](#using-jobby) to understand
126+
the command structure of Jobby, or visit [Features Section](#features) to see the full capabilities of Jobby!
175127

176128
--------------------------------------------------------------------------------------------------------------------
177129

docs/images/ug-images/app-added.png

440 KB
Loading

docs/images/ug-images/org-added.png

340 KB
Loading

docs/images/ug-images/rec-added.png

361 KB
Loading

0 commit comments

Comments
 (0)