Rating
| Target release | 11/19/2023 |
| Document status | DRAFT |
| Document owner | [email protected], [email protected] |
| Developer | [email protected], [email protected], |
| QA | [email protected] |
🎯 Objective
| Objective |
|---|
| The store owner will have an overall view of the shop’s quality through reviews. |
| Managing reviews easily can make the process much smoother. |
🤔 Assumptions
- The project assumes that there is an existing system or database that stores feedback data, including personal information.
- Users can view and analyze detailed information about reviews.
- The project assumes that there are no significant changes in the underlying technology stack during development.
How to use the Rating feature
Setting up the rating feature:
This feature will be configured in the license on the web and placed in the Feature tab. The rating setup will consist of three parts: - Ratings & Reviews - Yelp Rating - Email Template
1. Ratings & Reviews
- The rating function only operates when this option is enabled.
- Enabling this function applies to both email and SMS.
2. Yelp Rating
- In this section, you must add the Yelp ID link for the business along with selecting the star rating to send to the link.
- When customers receive an email/SMS for rating, it will depend on the star rating chosen here to determine whether to send the customer’s review to Yelp or store it in the business’s report.
- When this option is not enabled, all user ratings will not be sent to Yelp but will be displayed on the business’s report page.
3. Email Template
This section displays the sample template that users will receive via email.
🌟 Milestones
Create a visual road-map and help your team stay on track.
🗒️ Requirements
| Requirement | User Story |
|---|---|
| Mobile responsive | The review and rating management system should be mobile-responsive, ensuring a seamless experience for users accessing it from various devices such as smartphones and tablets. |
| Data completeness | Capture comprehensive data in each review, including the user’s feedback, ratings, order details, and any additional relevant information. |
| Data security | Implement robust data security measures to safeguard user information and reviews. Use encryption for sensitive data and ensure compliance with data protection regulations. |
| Increased convenience | Design an intuitive and user-friendly interface for submitting reviews and ratings. Streamline the process to make it quick and convenient for users to share their feedback. |
| Record keeping | Maintain a detailed record of all reviews and ratings, including timestamps, user details, and associated order information. This record should be easily accessible for reference and analysis. |
⚡ API Integration
| Description | API |
|---|---|
| Request list of reviews | /FeedbackAPI/api/feedbacks/store/{storeID} |
| Request list of Sale Types | /FeedbackAPI/api/feedback-report/store/{storeID}/sale-types?source=1 |
| Request feedback summary | /FeedbackAPI/api/feedback-report/store/{storeID}/rating-summary |
| Request feedback insight | /FeedbackAPI/api/feedback-report/store/{storeID}/insight |
| Update Replied feedback status | /FeedbackAPI/api/feedbacks/replied-status |
🎨 User interaction and design
To access Rating & Reviews - Summary, go to Rating & Reviews on the side menu bar
We have 4 sections
The summary section includes the following metrics: - Average Ratings: The average rating score of all customers who have rated. - Total Ratings Received: The total number of received ratings. - Positive Reviews: The number of reviews with a rating greater than 3. - Negative Reviews: The number of reviews with a rating less or equal to 3.
Overall Ratings - Summary Rating by Star: Breakdown of the summary ratings by star, giving a quick overview of the distribution of ratings.
Statistics of Ratings by SaleType - Insightful statistics on ratings by source, helping store owners understand where their feedback is coming from.
Detailed Rating Chart Over Time - A comprehensive chart detailing ratings over time, providing a historical perspective on the store’s performance.
Reviews
The Reviews Table provides information on the latest reviews, allowing store owners to stay updated on customer feedback.
❓️ Open Questions
| Question | Answer |
|---|---|
⚠️ Out of Scope
List the features discussed which are out of scope or might be revisited in a later release.