Skip to content

update: change vision documentation format #3

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

Merged
songlim327 merged 13 commits into from
Feb 14, 2025
Merged

update: change vision documentation format #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
22931cf
update: add hierarchy to vision documentation
yam425 Feb 3, 2025
48ee2ec
update: fix formatting issue & make consistent in gift pages
jssql1234 Feb 3, 2025
0ec431d
update: remove numbering from image
2000YokeKei Feb 5, 2025
5cacee5
update: reformat task-creation
yam425 Feb 3, 2025
7d04ee4
update: reformat task detail
Peichen0828 Feb 4, 2025
6cb0c72
update: reformat main dashboard
TanJunWei277049 Feb 4, 2025
19816ac
feat: add strategy documentation (add and edit feature)
yam425 Feb 6, 2025
b5a00e5
update: resize and renamed images for wallet
LawYeuHan Feb 3, 2025
d460043
update: reformat upskill
Peichen0828 Feb 10, 2025
a1871c6
update: change "update" link in gift manager part
jssql1234 Feb 11, 2025
65806b1
update: change vision documentation format
jssql1234 Feb 11, 2025
eb0e2ca
feat: add group documentation
yam425 Feb 12, 2025
853d190
Merged: documentation for new group feature in v1.1.0 release
jssql1234 Feb 14, 2025
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
3 changes: 1 addition & 2 deletions docs/integration/vision/gift/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
sidebar_position: 1
---

# Gift Introduction
# Introduction

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.

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

84 changes: 40 additions & 44 deletions docs/integration/vision/gift/manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,63 +1,62 @@
---
sidebar_position: 3
sidebar_position: 2
---

# Manager
# Manager View

:::info[Note]

These feature is only available to **manager**.
These features are only available to **manager**.

:::

## Gift Creation

:::info[Note]
After a manager creates a gift, users receive a notification about the new gift.
After manager creates a gift, users will receive notification regarding the new gift.
:::
To add a new gift, managers can go to **More icon> Add Gift**.

1. To add a new gift, managers can go to **More icon> Add Gift**.

![gift](../../../../static/img/integration/vision/gift/gotoAddGift.png)

### 1. Gift Redemption Details
2. Gift Redemption Details

![gift](../../../../static/img/integration/vision/gift/addGiftStep1.png)

| Properties | Description | Note |
|:-----------------------------|:-----------------------------------------------------------------------------------|:--------:|
| **1.0 Name** | The name of the gift. | Required |
| **1.1 Description** | A detailed description of the gift. | Required |
| **1.2 Terms & Conditions** | To specify the rules, requirements, guidelines, and limitations that the user must agree to in order to redeem the gift. | Required |
| **1.3 Redemption Validity Start Date** | The first date when the gift can be redeemed. | Required |
| **1.4 Redemption Validity End Date** | The last date when the gift can be redeemed. | Required |
| **1.5 Clear** | Clears all content on the current page. | - |
| **1.6 Next** | Navigates to the previous page. | - |
| **Name** | The name of the gift. | Required |
| **Description** | A detailed description of the gift. | Required |
| **Terms & Conditions** | To specify the rules, requirements, guidelines, and limitations that the user must agree to in order to redeem the gift. | Required |
| **Redemption Validity Start Date** | The first date when the gift can be redeemed. | Required |
| **Redemption Validity End Date** | The last date when the gift can be redeemed. | Required |
| **Clear** | Clears all content on the current page. | - |
| **Next** | Navigates to the previous page. | - |

### 2. Gift Redeemption Criteria
3. Gift Redemption Criteria

![gift](../../../../static/img/integration/vision/gift/addGiftStep2.png)

| Properties | Description | Note |
|:-----------------------------|:-----------------------------------------------------------------------------------|:--------:|
| **2.0 Redeem Coins** | To specify the amount of coins required to redeem the gift. | Required |
| **2.1 Category** | To select a category to classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
| **2.2 Available Quantity** | To specify the total number of units of the gift that are available for redemption. | Required |
| **2.3 Max Allowable Redemption Per Employee** | To specify the maximum number of times a user can redeem the gift.| Required |
| **2.4 Attactment** | To upload an image associated with the gift, such as a product photo or promotional graphic, through the mobile's camera or gallery. | - |
| **2.5 Clear** | Clears all content on the current page. | - |
| **2.6 Back** | Navigates to the previous page. | - |
| **2.7 Create** | To submit and create the new gift entry after filling in all required details. | - |

| **Redeem Coins** | To specify the amount of coins required to redeem the gift. | Required |
| **Category** | To select a category to classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
| **Available Quantity** | To specify the total number of units of the gift that are available for redemption. | Required |
| **Max Allowable Redemption Per Employee** | To specify the maximum number of times a user can redeem the gift.| Required |
| **Attactment** | To upload an image associated with the gift, such as a product photo or promotional graphic, through the mobile's camera or gallery. | - |
| **Clear** | Clears all content on the current page. | - |
| **Back** | Navigates to the previous page. | - |
| **Create** | To submit and create the new gift entry after filling in all required details. | - |

## Gift Update

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

### 1. Choose Gift

To update a gift, the manager can go to **More icon > Manage Gift** and select the gift want to be update.
|![gift](../../../../static/img/integration/vision/gift/gotoManageGift.png)|![gift](../../../../static/img/integration/vision/gift/chooseEditGift.png) |
|:------------------------------------|:-----------------------------------------------------|

### 2. Update Gift Details
In step 2 of edit mode, the user can update the gift's status using the **"Set as Active"** field.
2. Update Gift Details - In step 2 of edit mode, the user can update the gift's status using the **"Set as Active"** field.

:::info[Note]

Expand All @@ -68,50 +67,47 @@ The **Active** status can only be set if the Redemption Validity End Date is **o
|![gift](../../../../static/img/integration/vision/gift/editGiftStep1.png)|![gift](../../../../static/img/integration/vision/gift/editGiftStep2.png) |
|:------------------------------------|:-----------------------------------------------------|

## Gift Issue
## Gift Issue

### 1. Choose Gift Issuance Request
### Choose Gift Issuance Request

The gift can only be issued after the user has redeemed it. To issue a gift, the manager can go to **More icon > Manage Redemption** and select a gift issuance request.

|![gift](../../../../static/img/integration/vision/gift/gotoManageRedemption.png)|![gift](../../../../static/img/integration/vision/gift/chooseIssueGift.png) |
|:------------------------------------|:-----------------------------------------------------|

### 2. Confirm Issuance
### Confirm Issuance

After clicking **Issue**, select **Confirm** to complete issuing the gift.

|![gift](../../../../static/img/integration/vision/gift/issueConfirmation.png)|![gift](../../../../static/img/integration/vision/gift/doneIssuedGift.png) |
|:------------------------------------|:-----------------------------------------------------|

### 3. Check Issuance
### Check Issuance

To check completed issuances, **toggle on Issued Gift**s to display the latest issued gift.

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


## Manage Gift

### 1. Gift Status
### Gift Status

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

|Propertise|Description|
|:--------------------------------|:--------------------------------|
|**1.0 Inactive Gifts Switch - Toggle Off**|Displays all active gifts.|
|**1.1 Deactivate**|Deactivate all currently selected active gifts|
|**1.2 Inactive Gifts Switch - Toggle On**|Displays all inactive gifts.|
|**1.3 Active**|Activate all currently selected inactive gifts|
|**Inactive Gifts Switch - Toggle Off**|Displays all active gifts.|
|**Deactivate**|Deactivate all currently selected active gifts|
|**Inactive Gifts Switch - Toggle On**|Displays all inactive gifts.|
|**Active**|Activate all currently selected inactive gifts|

### 2. Expired Gift
### Expired Gift

The activation will **fail** if the gift has expired. To activate the gift, the manager must [**update**](#2-update-gift-details) its **Redemption Validity End Date**.
The activation will **fail** if the gift has expired. To activate the gift, the manager must [**update**](#gift-update) its **Redemption Validity End Date**.

|![gift](../../../../static/img/integration/vision/gift/expiredGift.png)|![gift](../../../../static/img/integration/vision/gift/activationFailed.png) |
|:------------------------------------|:-----------------------------------------------------|




48 changes: 23 additions & 25 deletions docs/integration/vision/gift/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
sidebar_position: 2
sidebar_position: 3
---

# User
# User View

:::info[Note]

Expand All @@ -11,29 +11,29 @@ These feature are available to both **manager** and **employee**.
:::

## Gift Redeem
### 1. Gift Filter Type

1. Gift Filter Type

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

|Propertise|Description|
|:--------------------------------|:--------------------------------|
|**1.0 Gift Category Filter Chip**|Displays all gifts that match any of the chosen categorie.|
|**1.1 Clear**| Deselect all the selected filter option.|
|**1.2 Shop By Price Filter**|Display gifts that match any of the chosen specific price ranges.|
|**1.3 Sort by Featured**|Display the gifts bassed on popularity in descending order.|
|**1.4 Sort by Newest**|Display the most recently added gifts in descending order.|
|**1.5 Sort by Price: High-to-Low**|Display gifts from expensive to cheap.|
|**1.6 Sort by Price: Low-to-High**|Display gifts from cheap to expensive.|
|**1.7 Reset**|Select all the filter options again.|


### 2. Choose gift
Choose a gift, and a bottom bar will appear.
|**Gift Category Filter Chip**|Displays all gifts that match any of the chosen categorie.|
|**Clear**| Deselect all the selected filter option.|
|**Shop By Price Filter**|Display gifts that match any of the chosen specific price ranges.|
|**Sort by Featured**|Display the gifts bassed on popularity in descending order.|
|**Sort by Newest**|Display the most recently added gifts in descending order.|
|**Sort by Price: High-to-Low**|Display gifts from expensive to cheap.|
|**Sort by Price: Low-to-High**|Display gifts from cheap to expensive.|
|**Reset**|Select all the filter options again.|

2. Select gift - After selecting a gift, and a **bottom bar will appear**.

:::info[Note]

Once the gift has expired, it will no longer be displayed for redemption. The manager will need to [**update**](../gift/manager.md#2-update-gift-details) the redemption validity end date to reactivate the gift for future redemptions.
Once the gift has expired, it will no longer be displayed for redemption. The manager will need to [**update**](../gift/manager.md#gift-update) the redemption validity end date to reactivate the gift for future redemptions.

:::

Expand All @@ -42,20 +42,18 @@ Once the gift has expired, it will no longer be displayed for redemption. The ma

|Propertise|Description|
|:--------------------------------|:--------------------------------|
|**1.0 Validity Duration**|The period during which the gift can be redeemed. The gift will not be available for redemption before or after this period.|
|**1.1 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.|
|**1.2 Max Redeem**|The maximum quantity of a gift that a user is allowed to redeem. |
|**1.3 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.|
|**1.4 Redeem**|A button to add the selected gift to the gift cart.|
|**Validity Duration**|The period during which the gift can be redeemed. The gift will not be available for redemption before or after this period.|
|**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.|
|**Max Redeem**|The maximum quantity of a gift that a user is allowed to redeem. |
|**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.|
|**Redeem**|A button to add the selected gift to the gift cart.|

### 3. Confirm Redemption
After clicking **Redeem**, select **Confirm** to confirm. If the redemption is successful, a success dialog will appear automatically.
3. Confirm Redemption - After clicking **Redeem**, select **Confirm** to redeem the gift. If the redemption is successful, a success dialog will appear automatically.

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

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

:::info[Note]

Expand Down
76 changes: 76 additions & 0 deletions docs/integration/vision/group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
sidebar_position: 9
---

# Group

:::info[Note]

This feature is only available to **manager**.

:::

## Introduction

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

## Manage Group

Manager can view all the created groups in **Main Dashboard | Manage Group**. In this page, manager can **search**, **add**, **edit** and **delete** group.

![Manage Group](../../../static/img/integration/vision/group/g-1.png)

### Add Group

![Manage Group - Add](../../../static/img/integration/vision/group/g-add.png)

1. Tap **Add** to create a new group.
2. Enter **Group Name**.
3. Select **Group Members** and their **Roles**.
4. Tap **Save** to save the group.

### Edit Group

![Manage Group - Edit](../../../static/img/integration/vision/group/g-edit.png)

1. Tap on the **group card** that you want to edit. You'll see the previously saved Group Name, Group Members, and their Roles.
3. Edit by changing either the **Group Name**, **Group Members**, or their **Roles**.
4. Tap **Save** to save the changes.

### Delete Group

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

1. Swipe **Left** on the group card that you want to delete. Tap **Delete**.
2. Confirm by tapping **Yes**.

## Apply Group

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

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

1. Tap **Group** icon.
2. Select the group that you want to apply. You can select multiple groups.
3. Tap **Apply**. You will see the selected groups members appear in the list.


:::info[Note 1]

When multiple groups are selected, the Roles of duplicated Group Members will be applied according to the **last selected group**.

Example:

- **Group A:** Member A (No Role)
- **Group B:** Member A (Admin)

1. **Selecting A then B** → Member A becomes **Admin**.
2. **Selecting B then A** → Member A becomes **No Role**."

:::

:::info[Note 2]

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

:::
Loading