Skip to content

Commit 78337e7

Browse files
jssql1234yam425
andauthored
refactor: update vision documentation v1.3.3 (#7)
Co-authored-by: yam425 <maymaytan0729@gmail.com>
1 parent a1220c3 commit 78337e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+586
-503
lines changed

docs/integration/vision/gift/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 1
44

55
# Introduction
66

7-
The Gifts feature, accessible through **Main Dashboard > Wallet > Gifts**, allows managers to create digital gifts. All users can then redeem these gifts using coins earned by completing missions.
7+
The Gifts feature, accessible through **Main Dashboard > Wallet > Gifts**, allows managers to create digital gifts that all users can redeem using coins earned from completing missions.
88

99
|![gift](../../../../static/img/integration/vision/gift/giftIntro1.png)|![gift](../../../../static/img/integration/vision/gift/giftIntro2.png)|
1010
|:--------------------------------|:--------------------------------|

docs/integration/vision/gift/manager.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ After manager creates a gift, users will receive notification regarding the new
3232
| **Redemption Validity Start Date** | The first date when the gift can be redeemed. | Required |
3333
| **Redemption Validity End Date** | The last date when the gift can be redeemed. | Required |
3434
| **Clear** | Clears all content on the current page. | - |
35-
| **Next** | Navigates to the previous page. | - |
35+
| **Next** | Navigates to the next page. | - |
3636

3737
3. Gift Redemption Criteria
3838

@@ -41,8 +41,8 @@ After manager creates a gift, users will receive notification regarding the new
4141
| Properties | Description | Note |
4242
|:-----------------------------|:-----------------------------------------------------------------------------------|:--------:|
4343
| **Redeem Coins** | To specify the amount of coins required to redeem the gift. | Required |
44-
| **Category** | To select a category to classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
45-
| **Available Quantity** | To specify the total number of units of the gift that are available for redemption. | Required |
44+
| **Category** | To classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
45+
| **Available Quantity** | To specify the total number of gift units available for redemption. | Required |
4646
| **Max Allowable Redemption Per Employee** | To specify the maximum number of times a user can redeem the gift.| Required |
4747
| **Attactment** | To upload an image associated with the gift, such as a product photo or promotional graphic, through the mobile's camera or gallery. | - |
4848
| **Clear** | Clears all content on the current page. | - |
@@ -51,7 +51,7 @@ After manager creates a gift, users will receive notification regarding the new
5151

5252
## Gift Update
5353

54-
1. Choose Gift - To update a gift, the manager can go to **More icon > Manage Gift** and select the gift want to be update.
54+
1. To update a gift, the manager can go to **More icon > Manage Gift** and select the gift to be updated.
5555

5656
|![gift](../../../../static/img/integration/vision/gift/gotoManageGift.png)|![gift](../../../../static/img/integration/vision/gift/chooseEditGift.png) |
5757
|:------------------------------------|:-----------------------------------------------------|
@@ -85,20 +85,19 @@ After clicking **Issue**, select **Confirm** to complete issuing the gift.
8585

8686
### Check Issuance
8787

88-
To check completed issuances, **toggle on Issued Gift**s to display the latest issued gift.
88+
To check completed issuances, **toggle on Issued Gifts** to display the latest issued gift.
8989

9090
|![gift](../../../../static/img/integration/vision/gift/gotoIssuedPage.png)|![gift](../../../../static/img/integration/vision/gift/checkIssuance.png) |
9191
|:------------------------------------|:-----------------------------------------------------|
9292

9393
## Manage Gift
94-
9594
### Gift Status
9695

9796
|Active Gifts|Inactive Gifts |
9897
|:--------------------------------|:---------------------------------|
9998
|![gift](../../../../static/img/integration/vision/gift/activeGift.png)|![gift](../../../../static/img/integration/vision/gift/inactiveGift.png)|
10099

101-
|Propertise|Description|
100+
|Properties|Description|
102101
|:--------------------------------|:--------------------------------|
103102
|**Inactive Gifts Switch - Toggle Off**|Displays all active gifts.|
104103
|**Deactivate**|Deactivate all currently selected active gifts|

docs/integration/vision/gift/user.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ These feature are available to both **manager** and **employee**.
1010

1111
:::
1212

13-
## Gift Redeem
13+
## Gift Redemption
1414

15-
1. Gift Filter Type
15+
**1. Gift Filter Type**
1616

1717
|Gift Category Filter Chip|Filter Drawer|
1818
|:--------------------------------|:--------------------------------|
1919
|![gift](../../../../static/img/integration/vision/gift/filterChip.png)|![gift](../../../../static/img/integration/vision/gift/filterDrawer.png)|
2020

21-
|Propertise|Description|
21+
|Properties|Description|
2222
|:--------------------------------|:--------------------------------|
23-
|**Gift Category Filter Chip**|Displays all gifts that match any of the chosen categorie.|
23+
|**Gift Category Filter Chip**|Displays all gifts that match any of the selected categories.|
2424
|**Clear**| Deselect all the selected filter option.|
25-
|**Shop By Price Filter**|Display gifts that match any of the chosen specific price ranges.|
25+
|**Shop By Price Filter**|Display gifts that match any of the selected specific price ranges.|
2626
|**Sort by Featured**|Display the gifts bassed on popularity in descending order.|
2727
|**Sort by Newest**|Display the most recently added gifts in descending order.|
28-
|**Sort by Price: High-to-Low**|Display gifts from expensive to cheap.|
29-
|**Sort by Price: Low-to-High**|Display gifts from cheap to expensive.|
28+
|**Sort by Price: High-to-Low**|Display gifts from most expensive to least expensive.|
29+
|**Sort by Price: Low-to-High**|Display gifts from to least expensive to most expensive.|
3030
|**Reset**|Select all the filter options again.|
3131

32-
2. Select gift - After selecting a gift, and a **bottom bar will appear**.
32+
**2. Select Gift**: After choosing a gift, a bottom bar will appear.
3333

3434
:::info[Note]
3535

@@ -40,32 +40,32 @@ Once the gift has expired, it will no longer be displayed for redemption. The ma
4040
|![gift](../../../../static/img/integration/vision/gift/chooseGift.png)|![gift](../../../../static/img/integration/vision/gift/redeemGift.png)|
4141
|:--------------------------------|:--------------------------------|
4242

43-
|Propertise|Description|
43+
|Properties|Description|
4444
|:--------------------------------|:--------------------------------|
4545
|**Validity Duration**|The period during which the gift can be redeemed. The gift will not be available for redemption before or after this period.|
4646
|**Terms and Conditions**|A clickable text that directs users to the page outlining the rules, requirements, guidelines, and limitations they must agree to in order to redeem the gift.|
4747
|**Max Redeem**|The maximum quantity of a gift that a user is allowed to redeem. |
48-
|**Quantity Input Field**|A field that allow users to enter the desired quantity to redeem .It can be adjusted by either entering an amount in the text field or using the plus and minus buttons.|
48+
|**Quantity Input Field**|A field that allows users to enter the desired quantity to redeem. It can be adjusted by either entering a value in the text field or using the plus and minus buttons.|
4949
|**Redeem**|A button to add the selected gift to the gift cart.|
5050

51-
3. Confirm Redemption - After clicking **Redeem**, select **Confirm** to redeem the gift. If the redemption is successful, a success dialog will appear automatically.
51+
**3. Confirm Redemption**: After tapping **Redeem**, select **Confirm** to redeem the gift. If the redemption is successful, a success dialog will appear automatically.
5252

5353
|![gift](../../../../static/img/integration/vision/gift/confirmRedeem.png)|![gift](../../../../static/img/integration/vision/gift/redeemSuccess.png)|
5454
|:-----------------------------------|:-----------------------------------|
5555

56-
4. View Redemption - To view redeemed gifts, users can go to **Cart icon> MyRedemption**. If a gift shows as **0/1 issued**, it means that **one redemption has been made**, but it **has not yet been issued**.
56+
**4. View Redemption**: To view redeemed gifts, users can go to **Cart icon > My Redemption**. If a gift displays **0/1 issued**, it means one redemption has been made but **has not yet been issued**.
5757

5858
:::info[Note]
5959

60-
Users will need to wait for approval or issuance from the manager before the gift can be used.
60+
Users must wait for manager approval or issuance before the gift can be used.
6161

6262
:::
6363

6464
|![gift](../../../../static/img/integration/vision/gift/goRedeemCart.png)|![gift](../../../../static/img/integration/vision/gift/myRedemption.png)|
6565
|:-----------------------------------|:-----------------------------------|
6666

6767
## Redemption Log
68-
Redemption log lets users view a history of redeemed rewards, showing who redeemed each reward and when it was redeemed.
68+
The redemption log allows users to view the history of redeemed rewards, including who redeemed each reward and when it was redeemed.
6969

7070
To view the redemption log, users can go to **More icon> Redemption Log**.
7171

docs/integration/vision/group.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This feature is only available to **manager**.
1212

1313
## Introduction
1414

15-
**Group** is a feature that allows manager to do grouping in advance. These groups can then be applied when creating a Target, Assignment or Upskill without requiring manager to select the members individually.
15+
**Group** is a feature that allows manager to do grouping in advance. These groups can then be applied when creating a *Target, Assignment or Upskill* without requiring manager to select the members individually.
1616

1717
## Manage Group
1818

@@ -22,31 +22,34 @@ Manager can view all the created groups in **Main Dashboard | Manage Group**. In
2222

2323
### Add Group
2424

25-
![Manage Group - Add](../../../static/img/integration/vision/group/g-add.png)
25+
| ![Manage Group - Add](../../../static/img/integration/vision/group/g-add-1.jpg) || ![mobileDemo](../../../static/img/integration/vision/group/g-add-2.jpg) |
26+
|:---:|---|:---:|
2627

27-
1. Tap **Add** to create a new group.
28+
1. Tap **Add icon** on the top right to create a new group.
2829
2. Enter **Group Name**.
29-
3. Select **Group Members** and their **Roles**.
30-
4. Tap **Save** to save the group.
30+
3. Select participants as **Admin**, **Group Leader** and **Group Members**.
31+
4. Tap **Add** to save the group.
3132

3233
### Edit Group
3334

34-
![Manage Group - Edit](../../../static/img/integration/vision/group/g-edit.png)
35+
| ![Manage Group - Edit](../../../static/img/integration/vision/group/g-edit-1.jpg) || ![mobileDemo](../../../static/img/integration/vision/group/g-edit-2.jpg) |
36+
|:---:|---|:---:|
3537

36-
1. Tap on the **group card** that you want to edit. You'll see the previously saved Group Name, Group Members, and their Roles.
37-
3. Edit by changing either the **Group Name**, **Group Members**, or their **Roles**.
38-
4. Tap **Save** to save the changes.
38+
1. Tap on the **group card** that you want to edit. You will see the previously saved *Group Name*, *Admin*, *Group Leader*, and *Group Members*.
39+
3. Edit by changing either the **Group Name**, **Admin**, **Group Leader** and **Group Members**.
40+
4. Tap **Save** to save the changes, or **Cancel** to discard the changes.
3941

4042
### Delete Group
4143

4244
![Manage Group - Delete](../../../static/img/integration/vision/group/g-delete.png)
4345

4446
1. Swipe **Left** on the group card that you want to delete. Tap **Delete**.
4547
2. Confirm by tapping **Yes**.
48+
3. You can also delete a group when editing, on the top right **delete icon**.
4649

4750
## Apply Group
4851

49-
Group can be applied when creating a [**Target**](task/manager_view/task_creation/target#step-3---add-members), [**Assignment (Step 3)**](task/manager_view/task_creation/assignment#step-3---add-members) or an [**Upskill (Step 4)**](upskill/manager_view/upskill-creation#step-4---participants-information).
52+
Group can be applied when creating a [**Target**](task/manager_view/task_creation/target#step-3---participants-information), [**Assignment (Step 3)**](task/manager_view/task_creation/assignment#step-3---participants-information) or an [**Upskill (Step 4)**](upskill/manager_view/upskill-creation#step-4---participants-information).
5053

5154
![Manage Group - Apply](../../../static/img/integration/vision/group/g-apply.png)
5255

@@ -71,6 +74,6 @@ Example:
7174

7275
:::info[Note 2]
7376

74-
When a group is applied to an **assignment, upskill, or individual target**, the **Team Leader** role of any member in that group will be **automatically removed**.
77+
When a group is applied to an **assignment, upskill, or individual target**, the **Group Leader** role of any member in that group will be **automatically removed**.
7578

7679
:::

docs/integration/vision/linking-to-account.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 10
66

77
## Introduction
88

9-
SQL Vision are linked to SQL Account to get the amount of sales target achieved by employees.
9+
SQL Vision is linked to SQL Account to get the amount of sales target achieved by employees.
1010

1111
## Requirement
1212

@@ -49,7 +49,7 @@ The SQL Accounting Software must be open and logged in during the connection pro
4949

5050
6. Insert the company ID.
5151
7. Click **Get OTP** .
52-
8. Insert the OTP Get from the step 7 into the OTP field.
52+
8. Insert the OTP obtained from the Step 7 into the OTP field.
5353
9. Click **Get Token**.
5454
10. Click **Next** to continue the following steps.
5555

@@ -77,7 +77,7 @@ Suppose you’re managing a Sales Department and want to track Q1 sales targets:
7777

7878
1. For the mission **"Achieve Q1 Sales Target"**, assign the **"Invoice Based Strategy"** strategy.
7979

80-
2. With this setup, managers can update sales progress daily in SQL Vision by using SQL Vision Sync tool by mapping to the right Strategy ID. Managers can view the updated progress daily in SQL Vision.
80+
2. With this setup, managers can update sales progress daily in SQL Vision using SQL Vision Sync tool by mapping it to the correct Strategy ID. Managers can then view the updated progress daily in SQL Vision.
8181

8282
:::
8383

@@ -87,7 +87,7 @@ By default, SQL Vision automatically adds two pre-defined strategies to a newly
8787

8888
![Predefined Strategy](../../../static/img/integration/vision/account/predefined-strategy.png)
8989

90-
If the system encounters an error and fails to create the pre-defined strategies, you can manually add them by navigating to the Company Configuration section. When this issue occurs, the application will display a dialog box prompting you to add the default strategies manually, as shown in the image below:
90+
If the system encounters an error and fails to create the pre-defined strategies, you can manually add them by navigating to the **Company Configuration** section. When this issue occurs, the application will display a dialog box prompting you to add the default strategies manually, as shown in the image below:
9191

9292
![Predefined Strategy-Add](../../../static/img/integration/vision/account/predefined-strategy-add.png)
9393

@@ -100,7 +100,7 @@ To add a new strategy, follow these steps:
100100
1. Click the **add icon** to create a new strategy.
101101
2. Enter the strategy name.
102102
3. Click the **Add** button.
103-
4. Strategy added can be preview. Click **X** to remove it.
103+
4. Strategy added can be previewed. Click **X** to remove it.
104104
5. Click **Save** to apply changes.
105105
6. Click **Cancel** to discard the changes.
106106

@@ -110,7 +110,7 @@ To edit an existing strategy, follow these steps:
110110

111111
![Edit Strategy](../../../static/img/integration/vision/account/strategy-edit.png)
112112

113-
1. Click on the strategy you want like to edit.
113+
1. Click on the strategy you would like to edit.
114114
2. Edit the strategy name.
115115
3. Click the **Edit** button.
116116
4. Click **Save** to apply changes.

docs/integration/vision/linking-to-payroll.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 11
66

77
## Introduction
88

9-
SQL Vision are linked with SQL Payroll to process all cash rewards earned by employees.
9+
SQL Vision is linked with SQL Payroll to process all cash rewards earned by employees.
1010

1111
## Requirement
1212

@@ -39,6 +39,6 @@ All rewards will be classified as **Commission** by default. You can change the
3939
:::warning[Warning]
4040

4141
- You are **allowed** to process the reward for specific employees if the expected payout month is **within or before** the payroll process month.
42-
- If you **choose not to process** particular reward, update the expected payout date for the employee in SQL Vision through **[Wallet | Manage Payout](wallet#manage-payoutentitlement-page)**.
42+
- If you **choose not to process** particular reward, update the expected payout date for the employee in SQL Vision through **[Wallet | Manage Payout](wallet#manage-payoutentitlement)**.
4343

4444
:::

docs/integration/vision/login.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ sidebar_position: 1
1717

1818
![OTP Email](../../../static/img/integration/vision/login/receiveOTP.png)
1919

20-
3. **Resend OTP** allows user to request again an One-Time Password(OTP)
20+
3. **Resend OTP** allows user to request again an One-Time Password(OTP)
21+
2122
![Resend OTP](../../../static/img/integration/vision/login/resendOTP.png)
2223

2324
4. Verification

0 commit comments

Comments
 (0)